@microblink/blinkid-ux-manager 7.8.0 → 8000.0.0

package/types/index.rollup.d.ts

@@ -1,4 +1,5 @@
 import { AnalyticService } from '@microblink/blinkid-core';
+import { BlinkIdProcessResult } from '@microblink/blinkid-core';
 import { BlinkIdScanningResult } from '@microblink/blinkid-core';
 import { BlinkIdSessionSettings } from '@microblink/blinkid-core';
 import { CameraManager } from '@microblink/camera-manager';
@@ -6,10 +7,45 @@ import { CameraManagerComponent } from '@microblink/camera-manager';
 import { DeviceInfo } from '@microblink/blinkid-core';
 import { DocumentClassInfo } from '@microblink/blinkid-core';
 import { InputImageAnalysisResult } from '@microblink/blinkid-core';
-import { ProcessResultWithBuffer } from '@microblink/blinkid-core';
 import { RemoteScanningSession } from '@microblink/blinkid-core';
-import { ResultCompleteness } from '@microblink/blinkid-core';
 import { ScanningSettings } from '@microblink/blinkid-core';
+import { ScanningStatus } from '@microblink/blinkid-core';
+
+/**
+ * UI-facing classification of how a BlinkID session extracts data.
+ *
+ * The UX manager uses this mode to choose feedback copy, help/onboarding locale
+ * groups, and extraction-specific modal illustrations.
+ *
+ * - `full-document` - Standard document flow for document capture, MRZ, VIZ, or
+ *   mixed multi-side extraction.
+ * - `document-with-barcode` - Single-side document capture flow that requires
+ *   the barcode side to be scanned.
+ * - `barcode-only` - Barcode extraction flow with no document capture, MRZ, or
+ *   VIZ extraction.
+ */
+declare type BlinkIdExtractionMode = "full-document" | "document-with-barcode" | "barcode-only";
+
+/**
+ * Callback invoked after BlinkID processes a camera frame.
+ *
+ * @param frameResult - Process result for the current frame. This contains the
+ * input image analysis and result completeness data that the UX manager uses to
+ * map feedback state; it does not include the final scanning result.
+ * @param advanceToNextStep - Advances the scanning session to the next required
+ * step. Use this for custom flows that decide, from the frame result, that the
+ * current side or step is complete before the default UX flow advances. For
+ * example, call this once `frameResult` contains all data your integration
+ * needs, even if the default flow would keep waiting for an optional barcode
+ * step that is hard to capture on a poor camera.
+ * @param triggerStepTimeout - Immediately triggers the scan-step timeout path
+ * for the active step. Use this when custom validation decides that the current
+ * step should fail or stop waiting for more frames.
+ * @param getLastFrame - Returns the raw `ArrayBuffer` for the frame that
+ * produced `frameResult`. The buffer is intended for diagnostics or custom
+ * tooling that needs the exact last processed frame.
+ */
+export declare type BlinkIdFrameProcessCallback = (frameResult: BlinkIdProcessResult, advanceToNextStep: () => Promise<void>, triggerStepTimeout: () => void, getLastFrame: () => ArrayBuffer) => void;
 
 /**
  * Union type of all page transition state keys.
@@ -58,11 +94,64 @@ export declare const blinkIdPageTransitionKeys: readonly ["FLIP_CARD", "MOVE_TOP
  */
 export declare type BlinkIdProcessingError = "timeout" | "unsupported_document" | "result_retrieval_failed" | "unknown";
 
+export declare type BlinkIdProgress = {
+    /** Currently stabilized BlinkID UI state key. */
+    uiStateKey: BlinkIdUiStateKey;
+    /** Remaining state for the inactivity timeout. */
+    inactivity: BlinkIdProgressTimerState;
+    /** Remaining state for the scan-step timeout. */
+    perSide: BlinkIdProgressTimerState;
+    /** Remaining state for partially supported barcode auto-resolution. */
+    partiallySupportedBarcodeResolve: BlinkIdProgressTimerState;
+    /** Whether BlinkID is currently timing an active scan step. */
+    isTimingActiveScanStep: boolean;
+    /** Current camera playback state that controls timer pause/resume. */
+    playbackState: "idle" | "playback" | "capturing";
+    /** Latest raw mapped BlinkID UI key. */
+    mappedUiStateKey: BlinkIdUiStateKey;
+    /** Stabilized UI state key that last reset the inactivity timeout. */
+    inactivityResetUiStateKey?: BlinkIdUiStateKey;
+};
+
+export declare type BlinkIdProgressTimerState = {
+    /** Configured timeout duration in milliseconds. */
+    configuredMs: number | null;
+    /** Remaining timeout duration in milliseconds. */
+    remainingMs: number | null;
+    /** Whether this timer is idle, actively counting down, or paused. */
+    status: BlinkIdProgressTimerStatus;
+};
+
+export declare type BlinkIdProgressTimerStatus = "disabled" | "idle" | "running" | "paused";
+
 /**
  * The type of reticle to display.
  */
 export declare type BlinkIdReticleType = "searching" | "processing" | "error" | "done" | "flip" | "move_top" | "move_left" | "move_right";
 
+/**
+ * Copyright (c) 2026 Microblink Ltd. All rights reserved.
+ */
+export declare type BlinkIdTimeoutConfiguration = {
+    /**
+     * Maximum allowed inactivity window in milliseconds. The inactivity timer is
+     * reset whenever the stabilized BlinkID UI state changes. Set to `null` to
+     * disable the inactivity timeout.
+     */
+    inactivityTimeoutMs: number | null;
+    /**
+     * Maximum allowed capture duration for a single BlinkID scan step in
+     * milliseconds. Set to `null` to disable the scan-step timeout.
+     */
+    scanStepTimeoutMs: number | null;
+    /**
+     * Active-capture delay before resolving a barcode step once BlinkID reports a
+     * barcode whose parsing is not supported. Set to `null` to disable automatic
+     * resolution for partially supported barcodes.
+     */
+    partiallySupportedBarcodeResolveTimeoutMs: number | null;
+};
+
 export declare type BlinkIdUiErrorStateKey = (typeof blinkIdUiErrorStateKeys)[number];
 
 /**
@@ -198,28 +287,14 @@ export declare class BlinkIdUxManager {
     get uiStateKey(): BlinkIdUiStateKey;
     /** Latest mapped candidate key before stabilization. */
     get mappedUiStateKey(): BlinkIdUiStateKey;
-    /**
-     * @deprecated Use `mappedUiStateKey` (internal/debug) or `uiStateKey` (displayed state).
-     */
-    get rawUiStateKey(): BlinkIdUiStateKey;
+    /** Session-settings-derived extraction mode used by feedback and dialogs. */
+    get extractionMode(): BlinkIdExtractionMode;
     startUiUpdateLoop(): void;
     stopUiUpdateLoop(): void;
     /**
-     * Returns the timeout duration in ms. Null if timeout won't be triggered ever.
-     */
-    getTimeoutDuration(): number | null;
-    /**
-     * Returns the time in ms before the help tooltip is shown. Null if tooltip won't be auto shown.
-     *
-     * @deprecated This option will be removed in a future release. Use `helpTooltipShowDelay` in `FeedbackUiOptions` instead.
-     */
-    getHelpTooltipShowDelay(): number | null;
-    /**
-     * Returns the time in ms before the help tooltip is hidden. Null if tooltip won't be auto hidden.
-     *
-     * @deprecated This option will be removed in a future release. Use `helpTooltipHideDelay` in `FeedbackUiOptions` instead.
+     * Returns the active BlinkID timeout configuration.
      */
-    getHelpTooltipHideDelay(): number | null;
+    getTimeoutConfiguration(): BlinkIdTimeoutConfiguration;
     /**
      * Gets the haptic feedback manager instance.
      *
@@ -302,20 +377,24 @@ export declare class BlinkIdUxManager {
     /**
      * 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.
+     * @param callback - A function that receives the processed frame result and
+     * controls for custom step advancement, step timeout triggering, and access to
+     * the last processed frame buffer.
      * @returns A cleanup function that, when called, will remove the registered
      * callback.
      *
      * @example
-     * const cleanup = manager.addOnFrameProcessCallback((frameResult) => {
+     * const cleanup = manager.addOnFrameProcessCallback((frameResult, advanceToNextStep) => {
      *   console.log('Frame processed:', frameResult);
+     *   if (shouldAdvance(frameResult)) {
+     *     void advanceToNextStep();
+     *   }
      * });
      *
      * // Later, to remove the callback:
      * cleanup();
      */
-    addOnFrameProcessCallback(callback: (frameResult: ProcessResultWithBuffer) => void): () => void;
+    addOnFrameProcessCallback(callback: BlinkIdFrameProcessCallback): () => void;
     /**
      * Registers a callback function to be called when an error occurs during
      * processing.
@@ -333,6 +412,23 @@ export declare class BlinkIdUxManager {
      * cleanup();
      */
     addOnErrorCallback(callback: (errorState: BlinkIdProcessingError) => void): () => void;
+    /**
+     * Registers a callback function to receive BlinkID progress snapshots.
+     *
+     * @param callback - A function that will be called with progress data from
+     * the internal 30 FPS RAF loop.
+     * @returns A cleanup function that, when called, will remove the registered
+     * callback.
+     *
+     * @example
+     * const cleanup = manager.addOnProgressCallback((progress) => {
+     *   console.log('BlinkID progress:', progress);
+     * });
+     *
+     * // Later, to remove the callback:
+     * cleanup();
+     */
+    addOnProgressCallback(callback: (progress: BlinkIdProgress) => void): () => void;
     /**
      * Registers a callback function to be called when a document is filtered.
      *
@@ -351,42 +447,12 @@ export declare class BlinkIdUxManager {
      */
     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.
-     *
-     * @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.
-     *
-     * @deprecated This option will be removed in a future release. Use `helpTooltipShowDelay` in `FeedbackUiOptions` instead.
-     */
-    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.
+     * Updates the BlinkID timeout configuration.
      *
-     * @deprecated This option will be removed in a future release. Use `helpTooltipHideDelay` in `FeedbackUiOptions` instead.
+     * Updating the configuration resets timeout tracking for the current scan
+     * step so the new durations take effect immediately.
      */
-    setHelpTooltipHideDelay(duration: number | null): void;
+    setTimeoutConfiguration(timeoutConfiguration: Partial<BlinkIdTimeoutConfiguration>): void;
     handleCameraManagerError: (error: Error) => void;
     /**
      * Returns the initial UI state key used when resetting UX state.
@@ -433,12 +499,19 @@ export declare class BlinkIdUxManager {
     destroy(): void;
 }
 
+/**
+ * Options for the BlinkIdUxManager.
+ */
 export declare type BlinkIdUxManagerOptions = {
     /**
      * Initial UI state key used by the manager/stabilizer reset flow.
      * Defaults to `INTRO_FRONT_PAGE`.
      */
     initialUiStateKey?: BlinkIdUiStateKey;
+    /**
+     * Configures BlinkID scanning timeout behavior.
+     */
+    timeoutConfiguration?: Partial<BlinkIdTimeoutConfiguration>;
 };
 
 /**
@@ -461,71 +534,174 @@ export declare function createBlinkIdFeedbackUi(blinkIdUxManager: BlinkIdUxManag
  */
 export declare const createBlinkIdUxManager: (cameraManager: CameraManager, scanningSession: RemoteScanningSession, options?: BlinkIdUxManagerOptions) => Promise<BlinkIdUxManager>;
 
+/**
+ * Deep partial type that allows any string to be assigned to override values.
+ * This type is permissive to allow any partial override structure.
+ */
+declare type DeepPartialLocalized<T> = T extends Record<string, unknown> ? {
+    -readonly [K in keyof T]?: T[K] extends Record<string, unknown> ? DeepPartialLocalized<T[K]> | string : string;
+} : never;
+
 /**
  * Localization strings for en.
  */
 declare const _default: {
-    readonly alert_cancel_btn: "Cancel";
-    readonly alert_retry_btn: "Retry";
-    readonly blur_detected: "Keep document and phone still";
-    readonly camera_angle_too_steep: "Keep document parallel to phone";
-    readonly document_filtered: "Document not accepted";
-    readonly document_filtered_details: "Try scanning a different document.";
-    readonly document_not_recognized: "Document not recognized";
-    readonly document_not_recognized_details: "Scan the front side of a supported document.";
-    readonly document_scanned: "Success! Document scanned";
-    readonly document_too_close_to_edge: "Move farther";
-    readonly face_photo_not_fully_visible: "Keep face photo fully visible";
-    readonly flip_document: "Flip the document";
-    readonly flip_to_back_side: "Flip to the back side";
-    readonly front_side_scanned: "Success! Front side scanned";
-    readonly glare_detected: "Tilt or move document to remove reflection";
-    readonly help_aria_label: "Help";
-    readonly help_modal_back_btn: "Back";
-    readonly help_modal_blur_details_desktop: "Try to keep the device and document still while scanning. Moving either can blur the image and make data on the document unreadable.";
-    readonly help_modal_camera_lens_details: "Check your camera lens for smudges or dust. A dirty lens causes the final image to blur, making the document details unreadable and preventing successful scan of the data.";
-    readonly help_modal_camera_lens_title: "Clean your camera lens";
-    readonly help_modal_details_1: "Make sure you aren’t covering parts of the document with a finger, including the bottom lines. Also, watch out for hologram reflections that go over the document fields.";
-    readonly help_modal_details_2: "Avoid direct harsh light because it reflects from the document and can make parts of the document unreadable. If you can’t read data on the document, it won’t be visible to the camera either.";
-    readonly help_modal_details_3: "Try to keep the phone and document still while scanning. Moving either can blur the image and make data on the document unreadable.";
-    readonly help_modal_done_btn: "Done";
-    readonly help_modal_next_btn: "Next";
-    readonly help_modal_title_1: "Keep all the fields visible";
-    readonly help_modal_title_2: "Watch out for harsh light";
-    readonly help_modal_title_3: "Keep still while scanning";
-    readonly help_tooltip: "Need help?";
-    readonly keep_document_parallel: "Keep document parallel with screen";
-    readonly keep_document_still: "Keep document and device still";
-    readonly move_closer: "Move closer";
-    readonly move_farther: "Move farther";
-    readonly move_left: "Move to the page on the left";
-    readonly move_right: "Move to the page on the right";
-    readonly move_top: "Move to the page on top";
-    readonly occluded: "Keep the document fully visible";
-    readonly onboarding_modal_btn: "Start scanning";
-    readonly onboarding_modal_details: "Make sure you keep the document well lit. All document fields should be visible on the camera screen.";
-    readonly onboarding_modal_details_desktop: "Make sure you keep your camera lens clean and the document well lit. All document fields should be visible on the camera screen.";
-    readonly onboarding_modal_title: "Keep all the details visible";
-    readonly onboarding_modal_title_desktop: "Get ready to scan";
-    readonly resume_scanning: "Resume scanning";
-    readonly scan_data_page: "Scan the data page of the document";
-    readonly scan_last_page_barcode: "Scan barcode from the last page";
-    readonly scan_left_page: "Scan the left page";
-    readonly scan_right_page: "Scan the right page";
-    readonly scan_the_back_side: "Scan the back side of the document";
-    readonly scan_the_barcode: "Scan the barcode";
-    readonly scan_the_front_side: "Scan the front side of the document";
-    readonly scan_top_page: "Scan the top page";
-    readonly scan_unsuccessful: "Scan unsuccessful";
-    readonly scan_unsuccessful_details: "Unable to read the document. Please try again.";
-    readonly scanning_help: "Scanning help";
-    readonly scanning_instructions: "Scanning Instructions";
-    readonly scanning_screen: "Document scanning screen";
-    readonly too_bright: "Move to spot with less lighting";
-    readonly too_dark: "Move to brighter spot";
-    readonly wrong_left: "Move to the left page";
-    readonly wrong_right: "Move to the right page";
-    readonly wrong_top: "Move to the top page";
+    readonly document_filtered_modal: {
+        readonly details: "Try scanning a different document.";
+        readonly title: "Document not accepted";
+    };
+    readonly document_not_recognized_modal: {
+        readonly details: "Scan the front side of a supported document.";
+        readonly title: "Document not recognized";
+    };
+    readonly error_modal: {
+        readonly cancel_btn: "Cancel";
+        readonly retry_btn: "Retry";
+    };
+    readonly feedback_messages: {
+        readonly blur_detected: "Keep document and phone still";
+        readonly camera_angle_too_steep: "Keep document parallel to phone";
+        readonly document_scanned_aria: "Success! Document scanned";
+        readonly document_too_close_to_edge: "Move farther";
+        readonly face_photo_not_fully_visible: "Keep face photo fully visible";
+        readonly flip_document: "Flip the document";
+        readonly flip_to_back_side: "Flip to the back side";
+        readonly front_side_scanned_aria: "Success! Front side scanned";
+        readonly glare_detected: "Tilt or move document to remove reflection";
+        readonly keep_document_parallel: "Keep document parallel with screen";
+        readonly keep_document_still: "Keep document and device still";
+        readonly keep_still: "Keep still";
+        readonly move_closer: "Move closer";
+        readonly move_farther: "Move farther";
+        readonly move_left: "Move to the page on the left";
+        readonly move_right: "Move to the page on the right";
+        readonly move_top: "Move to the page on top";
+        readonly occluded: "Keep the document fully visible";
+        readonly scan_data_page: "Scan the data page of a document";
+        readonly scan_last_page_barcode: "Scan barcode from the last page";
+        readonly scan_left_page: "Scan the left page";
+        readonly scan_right_page: "Scan the right page";
+        readonly scan_the_back_side: "Scan the back side of a document";
+        readonly scan_the_barcode: "Scan the barcode";
+        readonly scan_the_barcode_side: "Scan the barcode side of a document";
+        readonly scan_the_front_side: "Scan the front side of a document";
+        readonly scan_top_page: "Scan the top page";
+        readonly too_bright: "Move to spot with less lighting";
+        readonly too_dark: "Move to brighter spot";
+        readonly wrong_left: "Move to the left page";
+        readonly wrong_right: "Move to the right page";
+        readonly wrong_top: "Move to the top page";
+    };
+    readonly help_button: {
+        readonly aria_label: "Help";
+        readonly tooltip: "Need help?";
+    };
+    readonly help_modal: {
+        readonly aria: "Scanning help";
+        readonly back_btn: "Back";
+        readonly barcode_only: {
+            readonly blur: {
+                readonly details: "Try to keep the phone and the barcode still while scanning. Moving either can blur the image and make the barcode difficult to read.";
+                readonly details_desktop: "Try to keep still while scanning. Moving can blur the image and make the barcode difficult to read.";
+                readonly title: "Keep still while scanning";
+                readonly title_desktop: "Keep still while scanning";
+            };
+            readonly camera_lens: {
+                readonly details_desktop: "Check your camera lens for smudges or dust. A dirty lens causes the final image to blur, making the barcode unreadable and preventing successful scan of the data.";
+                readonly title_desktop: "Clean your camera lens";
+            };
+            readonly lighting: {
+                readonly details: "Avoid direct harsh light because it can create glare on the barcode and make it difficult to scan. If the barcode isn’t clearly visible to you, the camera may not be able to read it either.";
+                readonly details_desktop: "Avoid direct harsh light because it can create glare on the barcode and make it difficult to scan. If the barcode isn’t clearly visible to you, the camera may not be able to read it either.";
+                readonly title: "Watch out for harsh light";
+                readonly title_desktop: "Watch out for harsh light";
+            };
+            readonly visibility: {
+                readonly details: "Make sure you aren’t covering parts of the barcode with a finger. Also, watch out for reflections that go over the barcode and could make it unreadable.";
+                readonly details_desktop: "Make sure you aren’t covering parts of the barcode with a finger. Also, watch out for reflections that go over the barcode and could make it unreadable.";
+                readonly title: "Keep the barcode visible";
+                readonly title_desktop: "Keep the barcode visible";
+            };
+        };
+        readonly document_with_barcode: {
+            readonly blur: {
+                readonly details: "Try to keep the phone and document still while scanning. Moving either can blur the image and make data on the document unreadable.";
+                readonly details_desktop: "Try to keep still while scanning. Moving can blur the image and make data on the document unreadable.";
+                readonly title: "Keep still while scanning";
+                readonly title_desktop: "Keep still while scanning";
+            };
+            readonly camera_lens: {
+                readonly details_desktop: "Check your camera lens for smudges or dust. A dirty lens causes the final image to blur, making the document details unreadable and preventing successful scan of the data.";
+                readonly title_desktop: "Clean your camera lens";
+            };
+            readonly lighting: {
+                readonly details: "Avoid direct harsh light because it reflects from the document and can make parts of the document unreadable. If you can’t read data on the document, it won’t be visible to the camera either.";
+                readonly details_desktop: "Avoid direct harsh light because it reflects from the document and can make parts of the document unreadable. If you can’t read data on the document, it won’t be visible to the camera either.";
+                readonly title: "Watch out for harsh light";
+                readonly title_desktop: "Watch out for harsh light";
+            };
+            readonly visibility: {
+                readonly details: "Make sure you aren’t covering parts of the barcode with a finger. Also, watch out for reflections that go over the barcode and could make it unreadable.";
+                readonly details_desktop: "Make sure you aren’t covering parts of the barcode with a finger. Also, watch out for reflections that go over the barcode and could make it unreadable.";
+                readonly title: "Keep the barcode visible";
+                readonly title_desktop: "Keep the barcode visible";
+            };
+        };
+        readonly done_btn: "Done";
+        readonly done_btn_aria: "Resume scanning";
+        readonly full_document: {
+            readonly blur: {
+                readonly details: "Try to keep the phone and document still while scanning. Moving either can blur the image and make data on the document unreadable.";
+                readonly details_desktop: "Try to keep still while scanning. Moving can blur the image and make data on the document unreadable.";
+                readonly title: "Keep still while scanning";
+                readonly title_desktop: "Keep still while scanning";
+            };
+            readonly camera_lens: {
+                readonly details_desktop: "Check your camera lens for smudges or dust. A dirty lens causes the final image to blur, making the document details unreadable and preventing successful scan of the data.";
+                readonly title_desktop: "Clean your camera lens";
+            };
+            readonly lighting: {
+                readonly details: "Avoid direct harsh light because it reflects from the document and can make parts of the document unreadable. If you can’t read data on the document, it won’t be visible to the camera either.";
+                readonly details_desktop: "Avoid direct harsh light because it reflects from the document and can make parts of the document unreadable. If you can’t read data on the document, it won’t be visible to the camera either.";
+                readonly title: "Watch out for harsh light";
+                readonly title_desktop: "Watch out for harsh light";
+            };
+            readonly visibility: {
+                readonly details: "Make sure you aren’t covering parts of the document with a finger, including the bottom lines. Also, watch out for hologram reflections that go over the document fields.";
+                readonly details_desktop: "Make sure you aren’t covering parts of the document with a finger, including the bottom lines. Also, watch out for hologram reflections that go over the document fields.";
+                readonly title: "Keep all the fields visible";
+                readonly title_desktop: "Keep all the fields visible";
+            };
+        };
+        readonly next_btn: "Next";
+    };
+    readonly onboarding_modal: {
+        readonly aria: "Scanning Instructions";
+        readonly barcode_only: {
+            readonly details: "Look for a barcode (a series of black lines or a square code). Point your camera at it and hold still — scanning will happen automatically.";
+            readonly details_desktop: "Look for a barcode (a series of black lines or a square code). Make sure you keep your camera lens clean and the barcode well lit.";
+            readonly title: "Locate and scan the barcode";
+            readonly title_desktop: "Clean your lens and locate barcode";
+        };
+        readonly btn: "Start scanning";
+        readonly document_with_barcode: {
+            readonly details: "Different types of IDs may have different barcode formats and locations. Look at the front and back of the ID for a barcode.";
+            readonly details_desktop: "Check the front and back of the ID for a barcode. Make sure you keep your camera lens clean and the document well lit.";
+            readonly title: "Locate barcode on ID";
+            readonly title_desktop: "Clean your lens and locate barcode";
+        };
+        readonly full_document: {
+            readonly details: "Make sure you keep the document well lit. All document fields should be visible on the camera screen.";
+            readonly details_desktop: "Make sure you keep your camera lens clean and the document well lit. All document fields should be visible on the camera screen.";
+            readonly title: "Keep all the details visible";
+            readonly title_desktop: "Get ready to scan";
+        };
+    };
+    readonly sdk_aria: "Document scanning screen";
+    readonly timeout_modal: {
+        readonly details: "Unable to read the document. Please try again.";
+        readonly title: "Scan unsuccessful";
+    };
 };
 
 /**
@@ -693,7 +869,7 @@ export declare type FeedbackUiOptions = {
     /**
      * The localization strings.
      */
-    localizationStrings?: Partial<LocalizationStrings>;
+    localizationStrings?: PartialLocalizationStrings;
     /**
      * If set to `true`, the BlinkID instance will not be terminated when the
      * feedback UI is unmounted.
@@ -713,18 +889,7 @@ export declare type FeedbackUiOptions = {
      * @defaultValue true
      */
     showHelpButton?: boolean;
-    /**
-     * The timeout for the help tooltip in ms.
-     *
-     * @defaultValue 3000
-     * @deprecated This option will be removed in a future release. Use `helpTooltipShowDelay` instead.
-     */
-    showHelpTooltipTimeout?: number;
-    /**
-     * Time in ms before the help tooltip is shown. If null, tooltip won't be auto shown.
-     *
-     * @defaultValue 5000
-     */
+    /** Time in ms before the help tooltip is shown. If null, tooltip won't be auto shown. */
     helpTooltipShowDelay?: number | null;
     /**
      * Time in ms before the help tooltip is hidden. If null, tooltip won't be auto hidden.
@@ -766,7 +931,12 @@ export declare type FeedbackUiOptions = {
  * selection.
  * @returns The UI state key representing what should be shown to the user.
  */
-export declare function getUiStateKey(frameProcessResult: PartialProcessResult, settings?: Partial<ScanningSettings>): BlinkIdUiMappableKey | undefined;
+export declare function getUiStateKey(scanningStatus: ScanningStatus, inputImageAnalysisResult: InputImageAnalysisResult, scanningSettings: ScanningSettings): BlinkIdUiMappableKey | undefined;
+
+/**
+ * Maps a session-level scanning status to a UI state key
+ */
+export declare function getUiStateKeyFromScanningStatus(scanningStatus: ScanningStatus): BlinkIdUiMappableKey | undefined;
 
 /**
  * Mapping of haptic feedback types to their durations.
@@ -834,20 +1004,22 @@ export declare type LocaleRecord = typeof _default;
 
 /**
  * The localization strings type.
+ * This allows for autocomplete for defaults, but also overriding with strings at any level.
+ * https://twitter.com/mattpocockuk/status/1709281782325977101
  */
-export declare type LocalizationStrings = {
-    [K in keyof LocaleRecord]: LocaleRecord[K] | (string & {});
-};
+export declare type LocalizationStrings = LocalizedValue<LocaleRecord>;
 
 /**
- * The partial process result.
+ * Recursively transforms a locale record to allow string overrides at any level.
  */
-export declare type PartialProcessResult = {
-    /** The input image analysis result. */
-    inputImageAnalysisResult: Partial<InputImageAnalysisResult>;
-    /** The result completeness. */
-    resultCompleteness: Partial<ResultCompleteness>;
-};
+declare type LocalizedValue<T> = T extends Record<string, unknown> ? {
+    [K in keyof T]: LocalizedValue<T[K]>;
+} | (string & Record<string, never>) : T | (string & Record<string, never>);
+
+/**
+ * Partial version of LocalizationStrings that allows any string to be assigned.
+ */
+export declare type PartialLocalizationStrings = DeepPartialLocalized<LocaleRecord>;
 
 /** Helper type to extract string keys from a state map */
 declare type StateKey<T extends UiStateMap> = keyof T & string;

package/types/ui/BlinkIdFeedbackUi.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) 2026 Microblink Ltd. All rights reserved.
  */
 import type { Component } from "solid-js";
-import { LocalizationStrings } from "./LocalizationContext";
+import { PartialLocalizationStrings } from "./LocalizationContext";
 import "virtual:uno.css";
 /**
  * The BlinkIdFeedbackUi component. This is the main component that renders the
@@ -13,6 +13,6 @@ import "virtual:uno.css";
  * @returns The BlinkIdFeedbackUi component.
  */
 export declare const BlinkIdFeedbackUi: Component<{
-    localization?: Partial<LocalizationStrings>;
+    localization?: PartialLocalizationStrings;
 }>;
 //# sourceMappingURL=BlinkIdFeedbackUi.d.ts.map

package/types/ui/BlinkIdFeedbackUi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlinkIdFeedbackUi.d.ts","sourceRoot":"","sources":["../../src/ui/BlinkIdFeedbackUi.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAY1C,OAAO,EAEL,mBAAmB,EAEpB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,iBAAiB,CAAC;AASzB;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAC7C,CAoNA,CAAC"}
+{"version":3,"file":"BlinkIdFeedbackUi.d.ts","sourceRoot":"","sources":["../../src/ui/BlinkIdFeedbackUi.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAY1C,OAAO,EAEL,0BAA0B,EAE3B,MAAM,uBAAuB,CAAC;AAI/B,OAAO,iBAAiB,CAAC;AASzB;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,0BAA0B,CAAC;CAC3C,CA0NA,CAAC"}