@microblink/blinkid-ux-manager 7.3.2 → 7.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microblink/blinkid-ux-manager",
-  "version": "7.3.2",
+  "version": "7.4.1",
   "author": "Microblink",
   "type": "module",
   "main": "./dist/blinkid-ux-manager.js",
@@ -11,8 +11,8 @@
     "types"
   ],
   "dependencies": {
-    "@microblink/blinkid-core": "^7.3.2",
-    "@microblink/camera-manager": "^7.2.1",
+    "@microblink/blinkid-core": "^7.4.1",
+    "@microblink/camera-manager": "^7.2.3",
     "type-fest": "^4.35.0"
   },
   "access": "public",

package/types/core/BlinkIdProcessingError.d.ts

@@ -6,4 +6,9 @@
  * the user to retry the scanning process.
  */
 export type BlinkIdProcessingError = "timeout" | "unknown";
+/**
+ * BlinkID Init errors are not something that should be handled by the end user
+ * therefore we don't need to display them in the UI. Camera permission errors
+ * are handled in the Camera Manager component.
+ */
 //# sourceMappingURL=BlinkIdProcessingError.d.ts.map

package/types/core/BlinkIdProcessingError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlinkIdProcessingError.d.ts","sourceRoot":"","sources":["../../src/core/BlinkIdProcessingError.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAE9B,SAAS,GAGT,SAAS,CAAC"}
+{"version":3,"file":"BlinkIdProcessingError.d.ts","sourceRoot":"","sources":["../../src/core/BlinkIdProcessingError.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAE9B,SAAS,GAGT,SAAS,CAAC;AAEd;;;;GAIG"}

package/types/core/BlinkIdUxManager.d.ts

@@ -8,46 +8,64 @@ import { BlinkIdProcessingError } from "./BlinkIdProcessingError";
 import { BlinkIdUiState, BlinkIdUiStateKey, blinkIdUiStateMap } from "./blinkid-ui-state";
 import { DocumentClassFilter } from "./DocumentClassFilter";
 /**
- * Manages the UX of the BlinkID SDK.
+ * The BlinkIdUxManager class. This is the main class that manages the UX of
+ * the BlinkID SDK. It is responsible for handling the UI state, the timeout,
+ * the help tooltip, and the document class filter.
  */
 export declare class BlinkIdUxManager {
     #private;
+    /** The camera manager. */
     cameraManager: CameraManager;
+    /** The scanning session. */
     scanningSession: RemoteScanningSession;
+    /** Whether the demo overlay should be shown. */
     showDemoOverlay: boolean;
+    /** Whether the production overlay should be shown. */
     showProductionOverlay: boolean;
+    /** The current UI state. */
     uiState: BlinkIdUiState;
+    /** The raw UI state key. */
     rawUiStateKey: BlinkIdUiStateKey;
+    /** The feedback stabilizer. */
     feedbackStabilizer: FeedbackStabilizer<typeof blinkIdUiStateMap>;
+    /** The session settings. */
     sessionSettings: BlinkIdSessionSettings;
+    /**
+     * The constructor for the BlinkIdUxManager class.
+     *
+     * @param cameraManager - The camera manager.
+     * @param scanningSession - The scanning session.
+     */
     constructor(cameraManager: CameraManager, scanningSession: RemoteScanningSession);
     /**
-     * Indicates whether the UI should display the demo overlay. Controlled by the license property.
+     * Indicates whether the UI should display the demo overlay. Controlled by the
+     * license property.
      */
     getShowDemoOverlay(): boolean;
     /**
-     * Indicates whether the UI should display the production overlay. Controlled by the license property.
+     * Indicates whether the UI should display the production overlay. Controlled by
+     * the license property.
      */
     getShowProductionOverlay(): boolean;
     /**
      * Returns the timeout duration in ms. Null if timeout won't be triggered ever.
-     * @returns The timeout duration in ms.
      */
     getTimeoutDuration(): number | null;
     /**
      * Returns the time in ms before the help tooltip is shown. Null if tooltip won't be auto shown.
-     * @returns The time in ms before the help tooltip is shown.
      */
     getHelpTooltipShowDelay(): number | null;
     /**
      * Returns the time in ms before the help tooltip is hidden. Null if tooltip won't be auto hidden.
-     * @returns The time in ms before the help tooltip is hidden.
      */
     getHelpTooltipHideDelay(): number | null;
     /**
      * Adds a callback function to be executed when the UI state changes.
-     * @param callback - Function to be called when UI state changes. Receives the new UI state as parameter.
+     *
+     * @param callback - Function to be called when UI state changes. Receives the
+     * new UI state as parameter.
      * @returns A cleanup function that removes the callback when called.
+     *
      * @example
      * const cleanup = manager.addOnUiStateChangedCallback((newState) => {
      *   console.log('UI state changed to:', newState);
@@ -58,8 +76,10 @@ export declare class BlinkIdUxManager {
     addOnUiStateChangedCallback(callback: (uiState: BlinkIdUiState) => void): () => void;
     /**
      * Registers a callback function to be called when a scan result is available.
+     *
      * @param callback - A function that will be called with the scan result.
-     * @returns A cleanup function that, when called, will remove the registered callback.
+     * @returns A cleanup function that, when called, will remove the registered
+     * callback.
      *
      * @example
      *
@@ -73,8 +93,11 @@ export declare class BlinkIdUxManager {
     addOnResultCallback(callback: (result: BlinkIdScanningResult) => void): () => void;
     /**
      * Registers a callback function to filter document classes.
-     * @param callback - A function that will be called with the document class info.
-     * @returns A cleanup function that, when called, will remove the registered callback.
+     *
+     * @param callback - A function that will be called with the document class
+     * info.
+     * @returns A cleanup function that, when called, will remove the registered
+     * callback.
      *
      * @example
      * const cleanup = manager.addDocumentClassFilter((docClassInfo) => {
@@ -87,8 +110,11 @@ export declare class BlinkIdUxManager {
     addDocumentClassFilter(callback: DocumentClassFilter): () => void;
     /**
      * Registers a callback function to be called when a frame is processed.
-     * @param callback - A function that will be called with the frame analysis result.
-     * @returns A cleanup function that, when called, will remove the registered callback.
+     *
+     * @param callback - A function that will be called with the frame analysis
+     * result.
+     * @returns A cleanup function that, when called, will remove the registered
+     * callback.
      *
      * @example
      * const cleanup = manager.addOnFrameProcessCallback((frameResult) => {
@@ -100,9 +126,12 @@ export declare class BlinkIdUxManager {
      */
     addOnFrameProcessCallback(callback: (frameResult: ProcessResultWithBuffer) => void): () => void;
     /**
-     * Registers a callback function to be called when an error occurs during processing.
+     * Registers a callback function to be called when an error occurs during
+     * processing.
+     *
      * @param callback - A function that will be called with the error state.
-     * @returns A cleanup function that, when called, will remove the registered callback.
+     * @returns A cleanup function that, when called, will remove the registered
+     * callback.
      *
      * @example
      * const cleanup = manager.addOnErrorCallback((error) => {
@@ -113,38 +142,70 @@ export declare class BlinkIdUxManager {
      * cleanup();
      */
     addOnErrorCallback(callback: (errorState: BlinkIdProcessingError) => void): () => void;
+    /**
+     * Registers a callback function to be called when a document is filtered.
+     *
+     * @param callback - A function that will be called with the document class
+     * info.
+     * @returns A cleanup function that, when called, will remove the registered
+     * callback.
+     *
+     * @example
+     * const cleanup = manager.addOnDocumentFilteredCallback((docClassInfo) => {
+     *   console.log('Document filtered:', docClassInfo);
+     * });
+     *
+     * // Later, to remove the callback:
+     * cleanup();
+     */
     addOnDocumentFilteredCallback(callback: (documentClassInfo: DocumentClassInfo) => void): () => void;
     /**
-     * Sets the duration after which the scanning session will timeout. The timeout can occur in various scenarios
-     * and may be restarted by different scanning events.
+     * Sets the duration after which the scanning session will timeout. The
+     * timeout can occur in various scenarios and may be restarted by different
+     * scanning events.
      *
-     * @param duration The timeout duration in milliseconds. If null, timeout won't be triggered ever.
-     * @param setHelpTooltipShowDelay If true, also sets the help tooltip show delay to half of the provided duration. If timeout duration is null, help tooltip show delay will be set to null. Defaults to true.
+     * @param duration The timeout duration in milliseconds. If null, timeout won't
+     * be triggered ever.
+     * @param setHelpTooltipShowDelay If true, also sets the help tooltip show
+     * delay to half of the provided duration. If timeout duration is null, help
+     * tooltip show delay will be set to null. Defaults to true.
      * @throws {Error} Throws an error if duration is less than or equal to 0 when not null.
      */
     setTimeoutDuration(duration: number | null, setHelpTooltipShowDelay?: boolean): void;
     /**
      * Sets the duration in milliseconds before the help tooltip is shown.
      * A value of null means the help tooltip will not be auto shown.
-     * @param duration The duration in milliseconds before the help tooltip is shown. If null, tooltip won't be auto shown.
-     * @throws {Error} Throws an error if duration is less than or equal to 0 when not null.
+     *
+     * @param duration The duration in milliseconds before the help tooltip is
+     * shown. If null, tooltip won't be auto shown.
+     * @throws {Error} Throws an error if duration is less than or equal to 0 when
+     * not null.
      */
     setHelpTooltipShowDelay(duration: number | null): void;
     /**
      * Sets the duration in milliseconds before the help tooltip is hidden.
      * A value of null means the help tooltip will not be auto hidden.
-     * @param duration The duration in milliseconds before the help tooltip is hidden. If null, tooltip won't be auto hidden.
-     * @throws {Error} Throws an error if duration is less than or equal to 0 when not null.
+     *
+     * @param duration The duration in milliseconds before the help tooltip is
+     * hidden. If null, tooltip won't be auto hidden.
+     * @throws {Error} Throws an error if duration is less than or equal to 0 when
+     * not null.
      */
     setHelpTooltipHideDelay(duration: number | null): void;
     /**
-     * Clears any active timeout.
+     * Clears the scanning session timeout.
      */
     clearScanTimeout: () => void;
     /**
-     * Resets the manager and clears all callbacks.
+     * Resets the scanning session.
+     *
+     * @param startFrameCapture Whether to start frame processing.
+     */
+    resetScanningSession(startFrameCapture?: boolean): Promise<void>;
+    /**
+     * Resets the BlinkIdUxManager. Clears all callbacks.
      *
-     * Does not reset the camera manager or the BlinkID core instance.
+     * Does not reset the camera manager or the scanning session.
      */
     reset(): void;
 }

package/types/core/BlinkIdUxManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlinkIdUxManager.d.ts","sourceRoot":"","sources":["../../src/core/BlinkIdUxManager.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EAGlB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,qBAAa,gBAAgB;;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,eAAe,EAAE,qBAAqB,CAAC;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,OAAO,EAAE,cAAc,CAAC;IACxB,aAAa,EAAE,iBAAiB,CAAC;IACjC,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,iBAAiB,CAAC,CAAC;IACjE,eAAe,EAAE,sBAAsB,CAAC;gBAwB9C,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,qBAAqB;IA2DxC;;OAEG;IACH,kBAAkB,IAAI,OAAO;IAI7B;;OAEG;IACH,wBAAwB,IAAI,OAAO;IAInC;;;OAGG;IACH,kBAAkB,IAAI,MAAM,GAAG,IAAI;IAInC;;;OAGG;IACH,uBAAuB,IAAI,MAAM,GAAG,IAAI;IAIxC;;;OAGG;IACH,uBAAuB,IAAI,MAAM,GAAG,IAAI;IAIxC;;;;;;;;;;OAUG;IACH,2BAA2B,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI;IAOvE;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI;IAOrE;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,QAAQ,EAAE,mBAAmB;IAOpD;;;;;;;;;;;;OAYG;IACH,yBAAyB,CACvB,QAAQ,EAAE,CAAC,WAAW,EAAE,uBAAuB,KAAK,IAAI;IAQ1D;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,sBAAsB,KAAK,IAAI;IAiBzE,6BAA6B,CAC3B,QAAQ,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,IAAI;IA4G1D;;;;;;;OAOG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,uBAAuB,UAAO;IAY1E;;;;;OAKG;IACH,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ/C;;;;;OAKG;IACH,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAyG/C;;OAEG;IACH,gBAAgB,aAQd;IAEF;;;;OAIG;IACH,KAAK;CAUN"}
+{"version":3,"file":"BlinkIdUxManager.d.ts","sourceRoot":"","sources":["../../src/core/BlinkIdUxManager.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EAGlB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;;GAIG;AACH,qBAAa,gBAAgB;;IAC3B,0BAA0B;IAClB,aAAa,EAAE,aAAa,CAAC;IACrC,4BAA4B;IACpB,eAAe,EAAE,qBAAqB,CAAC;IAC/C,gDAAgD;IACxC,eAAe,EAAE,OAAO,CAAC;IACjC,sDAAsD;IAC9C,qBAAqB,EAAE,OAAO,CAAC;IACvC,4BAA4B;IACpB,OAAO,EAAE,cAAc,CAAC;IAChC,4BAA4B;IACpB,aAAa,EAAE,iBAAiB,CAAC;IACzC,+BAA+B;IACvB,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,iBAAiB,CAAC,CAAC;IACzE,4BAA4B;IACpB,eAAe,EAAE,sBAAsB,CAAC;IAgChD;;;;;OAKG;gBAED,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,qBAAqB;IA2DxC;;;OAGG;IACH,kBAAkB,IAAI,OAAO;IAI7B;;;OAGG;IACH,wBAAwB,IAAI,OAAO;IAInC;;OAEG;IACH,kBAAkB,IAAI,MAAM,GAAG,IAAI;IAInC;;OAEG;IACH,uBAAuB,IAAI,MAAM,GAAG,IAAI;IAIxC;;OAEG;IACH,uBAAuB,IAAI,MAAM,GAAG,IAAI;IAIxC;;;;;;;;;;;;;OAaG;IACH,2BAA2B,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI;IAOvE;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI;IAOrE;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,QAAQ,EAAE,mBAAmB;IAOpD;;;;;;;;;;;;;;;OAeG;IACH,yBAAyB,CACvB,QAAQ,EAAE,CAAC,WAAW,EAAE,uBAAuB,KAAK,IAAI;IAQ1D;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,sBAAsB,KAAK,IAAI;IAsBzE;;;;;;;;;;;;;;;OAeG;IACH,6BAA6B,CAC3B,QAAQ,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,IAAI;IAsK1D;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,uBAAuB,UAAO;IAY1E;;;;;;;;OAQG;IACH,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ/C;;;;;;;;OAQG;IACH,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IA+I/C;;OAEG;IACH,gBAAgB,aAQd;IAEF;;;;OAIG;IACG,oBAAoB,CAAC,iBAAiB,UAAO;IAkBnD;;;;OAIG;IACH,KAAK;CAWN"}

package/types/core/DocumentClassFilter.d.ts

@@ -5,10 +5,12 @@ import { DocumentClassInfo } from "@microblink/blinkid-core";
 /**
  * A type representing a filter function for document classification.
  *
- * This function is used to determine whether a document class is supported or not.
- * It takes a `DocumentClassInfo` object as input and returns a boolean value:
+ * This function is used to determine whether a document class is supported or
+ * not. It takes a `DocumentClassInfo` object as input and returns a boolean
+ * value:
  * - `true`: The document class is supported.
- * - `false`: The document class is not supported, and the document will be marked as "unsupported-document".
+ * - `false`: The document class is not supported, and the document will be
+ * marked as "unsupported-document".
  *
  * @param documentClassInfo - Information about the document class, such as country and type.
  *

package/types/core/DocumentClassFilter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentClassFilter.d.ts","sourceRoot":"","sources":["../../src/core/DocumentClassFilter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,iBAAiB,EAAE,iBAAiB,KACjC,OAAO,CAAC"}
+{"version":3,"file":"DocumentClassFilter.d.ts","sourceRoot":"","sources":["../../src/core/DocumentClassFilter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,iBAAiB,EAAE,iBAAiB,KACjC,OAAO,CAAC"}

package/types/core/blinkid-ui-state.d.ts

@@ -3,23 +3,61 @@
  */
 import { InputImageAnalysisResult, ResultCompleteness, ScanningSettings } from "@microblink/blinkid-core";
 import { UiState } from "@microblink/feedback-stabilizer";
+/**
+ * The type of reticle to display.
+ */
 export type BlinkIdReticleType = "searching" | "processing" | "error" | "done" | "flip" | "move_top" | "move_left" | "move_right";
+/**
+ * The key of the UI state.
+ */
 export type BlinkIdUiStateKey = "FLIP_CARD" | "DOCUMENT_CAPTURED" | "SENSING_FRONT" | "SENSING_BACK" | "SENSING_DATA_PAGE" | "SENSING_TOP_PAGE" | "SENSING_LEFT_PAGE" | "SENSING_RIGHT_PAGE" | "MOVE_TOP" | "MOVE_LEFT" | "MOVE_RIGHT" | "DOCUMENT_FRAMING_CAMERA_TOO_FAR" | "DOCUMENT_FRAMING_CAMERA_TOO_CLOSE" | "DOCUMENT_FRAMING_CAMERA_ANGLE_TOO_STEEP" | "DOCUMENT_TOO_CLOSE_TO_FRAME_EDGE" | "BLUR_DETECTED" | "GLARE_DETECTED" | "TOO_DARK" | "TOO_BRIGHT" | "OCCLUDED" | "FACE_PHOTO_OCCLUDED" | "UNSUPPORTED_DOCUMENT" | "SCAN_BARCODE" | "WRONG_TOP_PAGE" | "WRONG_LEFT_PAGE" | "WRONG_RIGHT_PAGE" | "WRONG_SIDE";
 /**
  * Extended UI state for BlinkID.
+ *
+ * @template K - The key of the UI state.
  */
 export type BlinkIdUiStateMap = {
     [K in BlinkIdUiStateKey]: UiState & {
+        /** The key of the UI state. */
         key: K;
+        /** The type of the reticle. */
         reticleType: BlinkIdReticleType;
     };
 };
+/**
+ * The states that are captured when the first side is captured.
+ */
 export declare const firstSideCapturedStates: BlinkIdUiStateKey[];
+/**
+ * The UI state of BlinkID.
+ */
 export type BlinkIdUiState = BlinkIdUiStateMap[keyof BlinkIdUiStateMap];
+/**
+ * The UI state map of BlinkID.
+ */
 export declare const blinkIdUiStateMap: BlinkIdUiStateMap;
+/**
+ * The partial process result.
+ */
 export type PartialProcessResult = {
+    /** The input image analysis result. */
     inputImageAnalysisResult: Partial<InputImageAnalysisResult>;
+    /** The result completeness. */
     resultCompleteness: Partial<ResultCompleteness>;
 };
+/**
+ * Determines the appropriate UI state key based on the current frame processing
+ * result and scanning settings.
+ *
+ * This function acts as a state machine, translating the low-level analysis and
+ * completeness results into a high-level UI state that drives the user
+ * interface.
+ *
+ * @param frameProcessResult - The current (possibly partial) result of frame
+ * processing, including image analysis and completeness.
+ * @param settings - Optional scanning settings that may influence state
+ * selection.
+ * @returns The UI state key representing what should be shown to the user.
+ */
 export declare function getUiStateKey(frameProcessResult: PartialProcessResult, settings?: Partial<ScanningSettings>): BlinkIdUiStateKey;
 //# sourceMappingURL=blinkid-ui-state.d.ts.map

package/types/core/blinkid-ui-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blinkid-ui-state.d.ts","sourceRoot":"","sources":["../../src/core/blinkid-ui-state.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAGL,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAG1D,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,YAAY,GACZ,OAAO,GACP,MAAM,GACN,MAAM,GACN,UAAU,GACV,WAAW,GACX,YAAY,CAAC;AAEjB,MAAM,MAAM,iBAAiB,GACzB,WAAW,GACX,mBAAmB,GACnB,eAAe,GACf,cAAc,GACd,mBAAmB,GACnB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,iCAAiC,GACjC,mCAAmC,GACnC,yCAAyC,GACzC,kCAAkC,GAClC,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,YAAY,GACZ,UAAU,GACV,qBAAqB,GACrB,sBAAsB,GACtB,cAAc,GACd,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,GAClB,YAAY,CAAC;AAEjB;;GAEG;AAEH,MAAM,MAAM,iBAAiB,GAAG;KAC7B,CAAC,IAAI,iBAAiB,GAAG,OAAO,GAAG;QAClC,GAAG,EAAE,CAAC,CAAC;QACP,WAAW,EAAE,kBAAkB,CAAC;KACjC;CACF,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,iBAAiB,EAK7C,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,iBAAiB,CAAC,MAAM,iBAAiB,CAAC,CAAC;AAExE,eAAO,MAAM,iBAAiB,EAAE,iBAgJtB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG;IACjC,wBAAwB,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5D,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjD,CAAC;AAMF,wBAAgB,aAAa,CAC3B,kBAAkB,EAAE,oBAAoB,EACxC,QAAQ,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,qBAqWrC"}
+{"version":3,"file":"blinkid-ui-state.d.ts","sourceRoot":"","sources":["../../src/core/blinkid-ui-state.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAEL,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAG1D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,YAAY,GACZ,OAAO,GACP,MAAM,GACN,MAAM,GACN,UAAU,GACV,WAAW,GACX,YAAY,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,WAAW,GACX,mBAAmB,GACnB,eAAe,GACf,cAAc,GACd,mBAAmB,GACnB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,iCAAiC,GACjC,mCAAmC,GACnC,yCAAyC,GACzC,kCAAkC,GAClC,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,YAAY,GACZ,UAAU,GACV,qBAAqB,GACrB,sBAAsB,GACtB,cAAc,GACd,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,GAClB,YAAY,CAAC;AAEjB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;KAC7B,CAAC,IAAI,iBAAiB,GAAG,OAAO,GAAG;QAClC,+BAA+B;QAC/B,GAAG,EAAE,CAAC,CAAC;QACP,+BAA+B;QAC/B,WAAW,EAAE,kBAAkB,CAAC;KACjC;CACF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,iBAAiB,EAK7C,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,iBAAiB,CAAC,MAAM,iBAAiB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,iBAgJtB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,uCAAuC;IACvC,wBAAwB,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5D,+BAA+B;IAC/B,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjD,CAAC;AAYF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAC3B,kBAAkB,EAAE,oBAAoB,EACxC,QAAQ,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,qBAqWrC"}

package/types/core/utils.d.ts

@@ -1,7 +1,25 @@
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/**
+ * Calculates the average of an array of numbers.
+ *
+ * @param arr - The array of numbers.
+ * @returns The average of the array.
+ */
 export declare function getAverage(arr: number[]): number;
+/**
+ * Converts an unknown value to an Error object.
+ *
+ * @param thrown - The value to convert.
+ * @returns The Error object.
+ */
 export declare const asError: (thrown: unknown) => Error;
+/**
+ * Sleeps for a given number of milliseconds.
+ *
+ * @param ms - The number of milliseconds to sleep.
+ * @returns A promise that resolves after the given number of milliseconds.
+ */
 export declare function sleep(ms: number): Promise<unknown>;
 //# sourceMappingURL=utils.d.ts.map

package/types/core/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/core/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,UAEvC;AAED,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,KAAG,KASzC,CAAC;AAEF,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,oBAErC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/core/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,UAEvC;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,KAAG,KASzC,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,oBAErC"}

package/types/index.d.ts

@@ -1,6 +1,12 @@
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/**
+ * @packageDocumentation
+ * User experience and interface components for BlinkID SDK - provides a complete UI layer for document scanning.
+ * This package includes feedback UI, localization support, and document scanning state management to create
+ * an intuitive document scanning experience.
+ */
 export * from "./core/blinkid-ui-state";
 export * from "./core/BlinkIdUxManager";
 export * from "./ui/createBlinkIdFeedbackUi";
@@ -8,7 +14,15 @@ export type { LocaleRecord, LocalizationStrings, } from "./ui/LocalizationContex
 export type { DocumentClassFilter } from "./core/DocumentClassFilter";
 export type * from "@microblink/feedback-stabilizer";
 export type { BlinkIdProcessingError } from "./core/BlinkIdProcessingError";
+/**
+ * The global interface.
+ *
+ * @see https://newsletter.daishikato.com/p/detecting-dual-module-issues-in-jotai
+ */
 declare const testSymbol: unique symbol;
+/**
+ * The global interface.
+ */
 declare global {
     var __BLINKID_UX_MANAGER__: typeof testSymbol;
 }

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,YAAY,EACV,YAAY,EACZ,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,iCAAiC,CAAC;AACrD,YAAY,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAG5E,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,sBAAsB,EAAE,OAAO,UAAU,CAAC;CAC/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,YAAY,EACV,YAAY,EACZ,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,iCAAiC,CAAC;AACrD,YAAY,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;GAIG;AACH,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,sBAAsB,EAAE,OAAO,UAAU,CAAC;CAC/C"}