@scandit/web-datacapture-core 8.1.1 → 8.2.0

package/build/js/{DataCaptureContext-fzPdCXUX.d.ts → DataCaptureContext-Dvdr7st4.d.ts}

@@ -1,15 +1,15 @@
 /// <reference types="emscripten" />
 import { a as Camera, D as DeviceCamera, l as CameraSettings, b as CameraPosition, g as FrameSource, f as FrameSourceJSON } from './Camera-DhGjpcjv.js';
 import { DataCaptureContextSettingsJSON, DataCaptureContextSettings } from './DataCaptureContextSettings.js';
-import { MarginsWithUnitJSON, MarginsWithUnit } from './commons/MarginsWithUnit.js';
-import { PointWithUnitJSON, PointWithUnit } from './commons/PointWithUnit.js';
+import { LogoStyle, FocusGestureJSON, ZoomGestureJSON, FocusGesture, ZoomGesture } from './DataCaptureViewPlusRelated.js';
+import { NotificationPresenter } from './NotificationPresenter/NotificationPresenter.js';
 import { Anchor } from './commons/Anchor.js';
+import { MarginsWithUnitJSON, MarginsWithUnit } from './commons/MarginsWithUnit.js';
 import { Orientation } from './commons/Orientation.js';
 import { Point, PointJSON } from './commons/Point.js';
+import { PointWithUnitJSON, PointWithUnit } from './commons/PointWithUnit.js';
 import { Quadrilateral } from './commons/Quadrilateral.js';
 import { Size } from './commons/Size.js';
-import { LogoStyle, FocusGestureJSON, ZoomGestureJSON, FocusGesture, ZoomGesture } from './DataCaptureViewPlusRelated.js';
-import { NotificationPresenter } from './NotificationPresenter/NotificationPresenter.js';
 import { Serializable } from './private/Serializable.js';
 import { DidTapCustomLocationsViewListener, StateToRender, StateToRenderDomView } from './private/CustomLocationsView.js';
 import { nativeHandle } from './private/nativeHandle.js';
@@ -27,21 +27,6 @@ import { HTMLElementStateJSON } from './private/HtmlElementState.js';
 import { AsyncStateMachine } from './private/utils/AsyncStateMachine.js';
 import { Optional, MethodSignature } from './tsHelper.js';
 
-type ControlType = "camera-fov" | "camera" | "shutter" | "torch";
-interface SerializedControl {
-    type: ControlType;
-}
-interface PrivateBaseControl {
-    install: (view: DataCaptureView$1) => Promise<boolean>;
-    remove: (definitiveRemoval?: boolean) => void;
-    update?: (view: DataCaptureView$1) => void;
-}
-interface Control extends Serializable<SerializedControl> {
-}
-interface PrivateControl extends Control, PrivateBaseControl {
-    view: DataCaptureView$1 | null;
-}
-
 interface DataCaptureOverlay extends Serializable {
     [nativeHandle]?: {
         className: string;
@@ -84,6 +69,7 @@ declare class DataCaptureView$1 implements Serializable<DataCaptureViewJSON> {
     private singleImageUploaderPaintboardElement?;
     private frameSourceListener;
     private _previewCamera;
+    private isConnected;
     private get videoElement();
     private visibilityListener;
     private cameraRecoveryListener;
@@ -109,7 +95,7 @@ declare class DataCaptureView$1 implements Serializable<DataCaptureViewJSON> {
     private onOrientationChangeListener;
     private hintPresenter;
     private onHintPresenterUpdateHandler;
-    private onBeforeShowToastsHandler;
+    private onViewFinderUpdateRequestedHandler;
     private onWorkerMessageHandler;
     private localizationSubscription?;
     private htmlElementDidChangeHandler;
@@ -165,6 +151,8 @@ declare class DataCaptureView$1 implements Serializable<DataCaptureViewJSON> {
     getNotificationPresenter(): NotificationPresenter;
     private removeStyles;
     private onHintPresenterUpdate;
+    /** Called when the hint presenter requests the viewfinder rect. */
+    private onViewFinderUpdateRequested;
     private clearHtmlElementContent;
     private setupHtmlElement;
     private setupHtmlElementSingleImageUploader;
@@ -176,7 +164,11 @@ declare class DataCaptureView$1 implements Serializable<DataCaptureViewJSON> {
     private handleVideoDisplay;
     private isCanvasDrawerWithMetrics;
     private onWorkerMessage;
-    private onBeforeShowToasts;
+    /**
+     * Called when the view size has changed and SDC has recalculated everything, including the viewfinder rect.
+     */
+    private onSDCViewSizeChangedCallback;
+    private updateHintPresenterViewFinderRect;
     private drawEngineCommands;
     private displayError;
     private clearError;
@@ -192,24 +184,19 @@ declare class DataCaptureView$1 implements Serializable<DataCaptureViewJSON> {
     private unfreezeFrame;
 }
 
-interface FrameData {
-    readonly width: number;
-    readonly height: number;
-    readonly isFrameSourceMirrored: boolean;
-    toBlob(type?: string, quality?: number): Promise<Blob | null>;
-    getData(): Promise<Uint8ClampedArray | null>;
+type ControlType = "camera-fov" | "camera" | "shutter" | "torch";
+interface SerializedControl {
+    type: ControlType;
 }
-type PrivateLoadableFrameData = Omit<FrameData, "getData" | "toBlob"> & {
-    frameId: number;
-};
-/**
- * Adds some function to the passed frame data object to let the user load the frame data.
- */
-declare function convertToPublicFrameData(loadableFrameData: PrivateLoadableFrameData, context: DataCaptureContext): FrameData;
-
-interface ModuleLoader {
-    moduleName: string;
-    load(options: ModuleLoaderOptions): Promise<any>;
+interface PrivateBaseControl {
+    install: (view: DataCaptureView$1) => Promise<boolean>;
+    remove: (definitiveRemoval?: boolean) => void;
+    update?: (view: DataCaptureView$1) => void;
+}
+interface Control extends Serializable<SerializedControl> {
+}
+interface PrivateControl extends Control, PrivateBaseControl {
+    view: DataCaptureView$1 | null;
 }
 
 /**
@@ -224,21 +211,23 @@ interface ExtractCentaurusLicenseResponse {
 type RequestFrameDataResponse = {
     data: Uint8ClampedArray;
     colorType: ColorType;
+    frameId: FrameId;
 } | {
     data: null;
     colorType: null;
+    frameId: null;
 };
 interface IsFeatureSupportedResponse {
     supported: boolean;
 }
-interface GetViewfinderInfo {
+interface GetViewfinderInfoResponse {
     isDisplayingViewfinder: boolean;
     rect: RectJSON;
 }
 interface GetOpenSourceSoftwareLicenseInfoResponse {
     licenseText: string;
 }
-type WorkerResponse<C> = C extends "processFrame" ? ProcessFrameParameters : C extends "extractCentaurusLicense" ? ExtractCentaurusLicenseResponse : C extends "requestFrameData" ? RequestFrameDataResponse : C extends "isFeatureSupported" ? IsFeatureSupportedResponse : C extends "getViewfinderInfo" ? GetViewfinderInfo : C extends "getOpenSourceSoftwareLicenseInfo" ? GetOpenSourceSoftwareLicenseInfoResponse : undefined;
+type WorkerResponse<C> = C extends "processFrame" ? ProcessFrameParameters : C extends "extractCentaurusLicense" ? ExtractCentaurusLicenseResponse : C extends "requestFrameData" ? RequestFrameDataResponse : C extends "isFeatureSupported" ? IsFeatureSupportedResponse : C extends "getViewfinderInfo" ? GetViewfinderInfoResponse : C extends "getOpenSourceSoftwareLicenseInfo" ? GetOpenSourceSoftwareLicenseInfoResponse : undefined;
 interface DataCaptureActionMessage {
     command: DataCaptureActionMessageKey;
     id: number;
@@ -262,11 +251,11 @@ type ProcessFrameDataCaptureAction = DataCaptureActionMessage & ProcessFramePara
 };
 type RequestFrameDataDataCaptureAction = DataCaptureActionMessage & {
     command: "requestFrameData";
-    frameId: number;
+    frameId: FrameId;
 };
 type DeleteFrameDataDataCaptureAction = DataCaptureActionMessage & {
     command: "deleteFrameData";
-    frameId: number;
+    frameId: FrameId;
 };
 type VisibilityChangeAction = DataCaptureActionMessage & {
     command: "documentVisibility";
@@ -329,7 +318,7 @@ type AnyDataCaptureActionMessage = ConvertToJPEGResultDataCaptureAction | Create
 /**
  * MESSAGES EMITTED BY THE WORKER
  */
-type DataCaptureCallbackMessageKeys = "contextDidChangeStatus" | "didStartObservingContext" | "draw" | "hideHint" | "isFeatureSupported" | "loadLibraryProgress" | "performanceMetricsReport" | "showHint" | "successFeedback" | "updateHint" | "workerTaskId" | "onFrameProcessingStarted" | "onFrameProcessingFinished" | "onFrameSkipped" | "showToast" | "hideToast" | "showGuidance" | "hideGuidance" | "startUpdateTimer" | "stopUpdateTimer" | "setViewfinderRect";
+type DataCaptureCallbackMessageKeys = "contextDidChangeStatus" | "didStartObservingContext" | "draw" | "hideHint" | "isFeatureSupported" | "loadLibraryProgress" | "performanceMetricsReport" | "showHint" | "successFeedback" | "updateHint" | "workerTaskId" | "onFrameProcessingStarted" | "onFrameProcessingFinished" | "onFrameSkipped" | "showToast" | "hideToast" | "showGuidance" | "hideGuidance" | "startUpdateTimer" | "stopUpdateTimer" | "setViewfinderRect" | "viewSizeChanged";
 interface BaseDataCaptureCallbackMessage {
     type: DataCaptureCallbackMessageKeys;
 }
@@ -440,7 +429,17 @@ type StartUpdateTimerMessage = BaseDataCaptureCallbackMessage & {
 type StopUpdateTimerMessage = BaseDataCaptureCallbackMessage & {
     type: "stopUpdateTimer";
 };
-type DataCaptureCallbackMessage = ConsoleWorkerMessage | ConvertToJPEGMessage | DidChangeStatusWorkerMessage | DrawWorkerMessage | HideHintWorkerMessage | IsFeatureSupportedMessage | LoadLibraryProgressMessage | PerformanceMetricsReportMessage | ShowHintWorkerMessage | StartObservingContextWorkerMessage | SuccessFeedbackWorkerMessage | UpdateHintWorkerMessage | WorkerTaskIdWorkerMessage | OnFrameProcessingStartedMessage | OnFrameProcessingFinishedMessage | OnFrameSkippedMessage | ShowToastMessage | HideToastMessage | ShowGuidanceMessage | HideGuidanceMessage | StartUpdateTimerMessage | StopUpdateTimerMessage;
+interface ViewInfo<T extends Orientation | number = Orientation> {
+    width: number;
+    height: number;
+    orientation: T;
+    viewFinderRect: RectJSON;
+}
+type ViewSizeChangedMessage = BaseDataCaptureCallbackMessage & {
+    type: "viewSizeChanged";
+    payload: ViewInfo | null;
+};
+type DataCaptureCallbackMessage = ConsoleWorkerMessage | ConvertToJPEGMessage | DidChangeStatusWorkerMessage | DrawWorkerMessage | HideHintWorkerMessage | IsFeatureSupportedMessage | LoadLibraryProgressMessage | PerformanceMetricsReportMessage | ShowHintWorkerMessage | StartObservingContextWorkerMessage | SuccessFeedbackWorkerMessage | UpdateHintWorkerMessage | WorkerTaskIdWorkerMessage | OnFrameProcessingStartedMessage | OnFrameProcessingFinishedMessage | OnFrameSkippedMessage | ShowToastMessage | HideToastMessage | ShowGuidanceMessage | HideGuidanceMessage | StartUpdateTimerMessage | StopUpdateTimerMessage | ViewSizeChangedMessage;
 /**
  * OTHERS
  */
@@ -480,6 +479,7 @@ interface GestureRecognizer extends EmscriptenClassHandle {
 }
 interface DataCaptureView extends EmscriptenClassHandle {
     setViewSize: (w: number, h: number, orientation: Orientation) => void;
+    getViewInfo: () => string;
     setNeedsRedrawDelegate: (delegate: unknown) => void;
     draw: () => void;
     getDrawCommands: () => Uint8Array;
@@ -554,6 +554,7 @@ declare enum HintIcon {
 }
 declare enum HintAnchor {
     Top = "top",
+    Center = "center",
     AboveViewFinder = "aboveViewFinder",
     BelowViewFinder = "belowViewFinder"
 }
@@ -610,10 +611,13 @@ interface GenericHint {
     hintStyle: Omit<HintStyle, "anchor" | "verticalOffsetRatio" | "font" | "hintWidth" | "hintHeight" | "hintCornerStyle">;
 }
 interface PerformanceMetrics {
-    processedFramesCount: number;
+    cameraOutputFrames: number;
     redrawRequestsCount: number;
     actualRedrawsCount: number;
     frameDataPoolSize: number;
+    frameProcessingStartedCount: number;
+    frameProcessedCount: number;
+    frameSkippedCount: number;
 }
 declare enum LicensedFeature {
     Ocr = 0,
@@ -770,6 +774,224 @@ interface ModuleHandler<M extends Module> {
     set: (v: M) => void;
 }
 
+interface LoadLibraryParameters {
+    libraryLocation: string;
+    locationPath: string;
+    writableDataPathOverride?: string;
+    indexedDBTimeoutMs: number;
+    verifyResponseHash: boolean;
+    onProgress?: (info: ProgressInfo) => void;
+    referredOrigin?: string;
+    fixedWasmMemory: number | null;
+    simdSupport: boolean;
+    threadsSupport: boolean;
+}
+interface CreateContextParameters {
+    context: DataCaptureContextJSON;
+    deviceId: string;
+    delayedRegistration: boolean;
+    highEndBlurryRecognition: boolean;
+    appName: string | null;
+    parentDomain: string;
+}
+interface UpdateContextParameters {
+    context: DataCaptureContextJSON;
+    view: {
+        width: number;
+        height: number;
+        visible: boolean;
+        orientation: Orientation;
+    } | null;
+}
+interface SetFrameSourceParameters {
+    mirrorAxis: PrivateMirrorAxis;
+    isCameraFrameSource: boolean;
+}
+type ProcessFrameParameters = FrameCapture;
+interface ReportCameraPropertiesParameters {
+    deviceId: string;
+    hasAutofocus: boolean;
+    isFrontFacing: boolean;
+}
+interface WorkerFunctions {
+    getOffscreenCanvas: () => OffscreenCanvas | undefined;
+    postMessage: (message: DataCaptureCallbackMessage, transfer?: Transferable[]) => void;
+}
+/**
+ * DataCaptureEngine is an abstraction of the engine, it is created by the engine worker
+ * and should be used as a singleton. It calls the underlying engine methods directly.
+ */
+declare class DataCaptureEngine<M extends Module> {
+    private static get3dPartyLicenseKeyMethodName;
+    context: DataCaptureContext$1;
+    lastUsedModuleMirrorAxis: unknown;
+    view: DataCaptureView | undefined;
+    hintPresenterV2: HintPresenterV2 | null;
+    /**
+     * Maximum number of frames to keep in the pool.
+     * Set to 5 to balance between:
+     * - Providing sufficient buffering for frame listener callbacks that may arrive slightly out-of-order
+     * - Minimizing memory overhead in the worker thread
+     * - At 30 fps, 5 frames = ~167ms of retention, sufficient for most listener callbacks
+     * - For higher frame rates, FIFO eviction prevents unbounded growth
+     */
+    protected readonly MAX_NUMBER_OF_IMAGES_IN_FRAME_DATA_POOL: number;
+    protected readonly moduleHandler: ModuleHandler<M>;
+    protected readonly redrawInterval: number;
+    protected readonly redrawRequests: number[];
+    protected readonly workerFunctions: WorkerFunctions;
+    protected _isDrawLoopRunning: boolean;
+    protected contextDeserializer: DataCaptureContextDeserializer | undefined;
+    /**
+     * Frame data pool that stores copies of frame data for access by listeners.
+     * Frame data is stored with frameId as key, typically using performance.now() for high-precision timing.
+     *
+     * Frame ID Generation & Management:
+     * - frameId comes from camera frame sources (typically performance.now() in milliseconds with decimal precision)
+     * - Frames are stored in insertion order (Map preserves insertion order in JavaScript)
+     * - Memory is managed through two complementary mechanisms:
+     *   1. Bounded pool size (MAX_NUMBER_OF_IMAGES_IN_FRAME_DATA_POOL) with FIFO eviction of oldest frames
+     *   2. Immediate deletion after transfer via requestFrameData() to give callers control over lifetime
+     * - For the deleteFrameData() API, frames marked for deletion are cleaned up on next prepareFrameForListener call
+     * - This combination prevents both unbounded memory growth and memory leaks from unrequested frames
+     */
+    protected frameDataPool: Map<FrameId, {
+        data: Uint8ClampedArray;
+        colorType: ColorType;
+        frameId: FrameId;
+        width: number;
+        height: number;
+    }>;
+    protected lastFrameColorType: ColorType;
+    protected lastFrameId: FrameId | null;
+    protected imageFrameSource?: DataCaptureImageBufferFrameSource;
+    protected libraryLoadingPromise: Promise<void> | undefined;
+    protected loopTimeoutId?: ReturnType<typeof setTimeout>;
+    protected resourcePath: string;
+    protected writableDataPath: string;
+    protected poorMansBenchmarkLogs: boolean;
+    protected parentDomain: string;
+    protected readonly writableDataPathStandard: string;
+    protected readonly resourceFilesSubfolder: string;
+    protected performanceMetricsReporterTimer: ReturnType<typeof setTimeout> | number | undefined;
+    protected lastMetricsReportTime: number;
+    protected readonly metricsReportInterval: number;
+    protected performanceMetrics: PerformanceMetrics;
+    protected frameProcessingStartedCount: number;
+    protected frameProcessingFinishedCount: number;
+    protected gestureRecognizer: GestureRecognizer | null;
+    private gestureListener;
+    private webPlatformHintPresenter;
+    private webImageConverterInstance;
+    private lastViewInfo;
+    constructor(moduleHandler: ModuleHandler<M>, workerFunctions: WorkerFunctions);
+    get Module(): M;
+    set isDrawLoopRunning(newValue: boolean);
+    get isDrawLoopRunning(): boolean;
+    /**
+     * Prepares frame data for listener callbacks by pooling it and cleaning up marked frames.
+     * Called on session update for tracking modes and on didScan for scan modes.
+     * @param frameData - The frame data to prepare for listener access.
+     * @returns The loadable frame data metadata.
+     */
+    prepareFrameForListener(frameData: WasmFrameData): PrivateLoadableFrameData;
+    createContext(createContextJSON: CreateContextParameters): EngineWorkerResponse<"createContext">;
+    convertToJPEGResult(imageId: number, result: Uint8Array): void;
+    /**
+     * Returns the ImageConverterInstance to be used in the worker thread. Depending on the availability of
+     * OffscreenCanvas, a different implementation is returned.
+     */
+    protected getImageConverterInstance(options: {
+        quality: number;
+    }): ImageConverterInstance;
+    onTap(point: PointJSON): void;
+    hintPresenterV2Update(): void;
+    private lastFrameProcessingStartedCount;
+    private lastFrameProcessingFinishedCount;
+    startReportingPerformanceMetrics(): void;
+    private scheduleMetricsReporting;
+    private checkAndReportMetrics;
+    reportPerformanceMetrics(): Promise<void>;
+    deleteFrameData(frameId: FrameId): void;
+    dispose(): EngineWorkerResponse<"dispose">;
+    private cleanupMetricsReporting;
+    flushAnalytics(): void;
+    extractCentaurusLicense(scanditLicenseKey: string): EngineWorkerResponse<"extractCentaurusLicense">;
+    getModeDeserializers(): Vector;
+    loadLibrary(parameters: LoadLibraryParameters): EngineWorkerResponse<"loadLibrary">;
+    processFrame(parameters: ProcessFrameParameters): EngineWorkerResponse<"processFrame">;
+    reportCameraProperties(properties: ReportCameraPropertiesParameters): EngineWorkerResponse<"reportCameraProperties">;
+    /**
+     * Request frame data from the pool.
+     * Converts grayscale to RGBA in the worker if needed.
+     * Frames are immediately deleted after transfer to prevent memory accumulation.
+     * @param frameId - The ID of the frame to retrieve.
+     * @returns The frame data, with the frame deleted from the pool immediately after.
+     */
+    requestFrameData(frameId: FrameId): EngineWorkerResponse<"requestFrameData">;
+    scheduleRedraw(view: DataCaptureView, redrawInMs: number): void;
+    sendViewRefreshCommands(commands: Uint8Array): void;
+    setFrameSource(mirrorAxis: PrivateMirrorAxis, isCameraFrameSource: boolean): EngineWorkerResponse<"setFrameSource">;
+    /**
+     * The draw loop check at regular interval if any redraw request were made by the engine.
+     * If a redraw is necessary, it gathers and sends drawing commands to the main thread.
+     */
+    startDrawLoop(view: DataCaptureView): void;
+    updateContext(contextUpdateParameters: UpdateContextParameters): EngineWorkerResponse<"updateContext">;
+    notifyMainThreadOnViewInfoChanged(view?: DataCaptureView): void;
+    protected getViewInfo(view?: DataCaptureView | null): ViewInfo | null;
+    protected getOrientationFromNumber(orientation: number): Orientation;
+    /**
+     * Called before updateContextFromJson
+     *
+     * @protected
+     * @param {UpdateContextParameters} contextUpdateParameters
+     * @returns {UpdateContextParameters}
+     */
+    protected onBeforeUpdateContextHook(contextUpdateParameters: UpdateContextParameters): UpdateContextParameters;
+    onDocumentVisibilityChange(state: DocumentVisibilityState): void;
+    isFeatureSupported(feature: LicensedFeature): EngineWorkerResponse<"isFeatureSupported">;
+    getViewfinderInfo(): EngineWorkerResponse<"getViewfinderInfo">;
+    getOpenSourceSoftwareLicenseInfo(): EngineWorkerResponse<"getOpenSourceSoftwareLicenseInfo">;
+    protected getWasmDynamicLibraries(coreWasmURI: string): string[];
+    protected getWasmCoreExpectedHash(simdSupport: boolean, threadsSupport: boolean): string;
+    protected getWasmCoreFileName(simdSupport: boolean, threadsSupport: boolean): string;
+    protected getWasmMetadata(): Record<string, {
+        bytes: number;
+    }>;
+    protected getWasmSideModuleFileName(): string;
+    private _loadProgressCallback;
+    /**
+     * Redraw requests are scheduled at [now + redrawInMs], so when pushed they must be sorted
+     * in chronological order so that we can later easily check if we need to redraw by checking
+     * the first element.
+     * @param redrawInMs
+     */
+    private addRedrawRequest;
+    private contextDidChangeStatus;
+    private didStartObservingContext;
+    private mapMirrorAxisOnModule;
+    protected setView(view: DataCaptureView | undefined): void;
+    /**
+     * Add a native overlay to the view without passing from the deserializer.
+     * must be implemented in the specific module.
+     * @param event - The message event containing the overlay handle.
+     */
+    addNativeOverlay(event: MessageEvent<AnyDataCaptureActionMessage>): void;
+    /**
+     * Remove a native overlay from the view.
+     * must be implemented in the specific module.
+     * @param event - The message event containing the overlay handle.
+     */
+    removeNativeOverlay(event: MessageEvent<AnyDataCaptureActionMessage>): void;
+    private setViewRefreshHandler;
+    private setupDataDecoding;
+    private start;
+    private getWritableDataPath;
+    private numOfMBToPages;
+    private setup;
+}
+
 declare enum MeteringMode {
     CONTINUOUS = "continuous",
     MANUAL = "manual",
@@ -805,9 +1027,40 @@ interface GUI {
     isCameraRecoveryVisible: () => boolean;
     setCameraRecoveryVisible: (visible: boolean) => void;
 }
+/**
+ * Branded type for frame IDs to improve type safety.
+ *
+ * Frame IDs are high-resolution timestamps generated via performance.now() using getTimestamp().
+ * Using a branded type prevents accidental mixing with other numeric IDs and
+ * makes the intent of numeric values explicit in type signatures.
+ *
+ * Example:
+ * ```typescript
+ * // ✓ Correct: explicitly marked as a frame ID
+ * const frameId: FrameId = getTimestamp() as FrameId;
+ *
+ * // ✗ TypeScript error: number is not assignable to FrameId
+ * const wrongId: FrameId = 12345;
+ * ```
+ *
+ * Benefits:
+ * - Prevents confusion between frame IDs and other numeric identifiers
+ * - Makes it immediately clear in function signatures that a value is a frame ID
+ * - Compiler catches accidental type mismatches at compile time
+ */
+declare const FrameIdBrand: unique symbol;
+type FrameId = number & {
+    readonly [FrameIdBrand]: "FrameId";
+};
+/**
+ * Creates a branded FrameId using the current high-resolution timestamp.
+ * @returns A branded FrameId value
+ */
+declare function createFrameId(): FrameId;
 interface FrameCapture {
     colorType?: ColorType;
     data: Uint8ClampedArray;
+    frameId: FrameId;
     height: number;
     width: number;
 }
@@ -997,172 +1250,24 @@ declare class CameraManager {
     private handleVideoPause;
 }
 
-interface LoadLibraryParameters {
-    libraryLocation: string;
-    locationPath: string;
-    writableDataPathOverride?: string;
-    verifyResponseHash: boolean;
-    onProgress?: (info: ProgressInfo) => void;
-    referredOrigin?: string;
-    fixedWasmMemory: number | null;
-    simdSupport: boolean;
-    threadsSupport: boolean;
-}
-interface CreateContextParameters {
-    context: DataCaptureContextJSON;
-    deviceId: string;
-    delayedRegistration: boolean;
-    highEndBlurryRecognition: boolean;
-    appName: string | null;
-    parentDomain: string;
-}
-interface UpdateContextParameters {
-    context: DataCaptureContextJSON;
-    view: {
-        width: number;
-        height: number;
-        visible: boolean;
-        orientation: Orientation;
-    } | null;
-}
-interface SetFrameSourceParameters {
-    mirrorAxis: PrivateMirrorAxis;
-    isCameraFrameSource: boolean;
-}
-type ProcessFrameParameters = FrameCapture;
-interface ReportCameraPropertiesParameters {
-    deviceId: string;
-    hasAutofocus: boolean;
-    isFrontFacing: boolean;
-}
-interface WorkerFunctions {
-    getOffscreenCanvas: () => OffscreenCanvas | undefined;
-    postMessage: (message: DataCaptureCallbackMessage, transfer?: Transferable[]) => void;
+interface FrameData {
+    readonly width: number;
+    readonly height: number;
+    readonly isFrameSourceMirrored: boolean;
+    toBlob(type?: string, quality?: number): Promise<Blob | null>;
+    getData(): Promise<Uint8ClampedArray | null>;
 }
+type PrivateLoadableFrameData = Omit<FrameData, "getData" | "toBlob"> & {
+    frameId: FrameId;
+};
 /**
- * DataCaptureEngine is an abstraction of the engine, it is created by the engine worker
- * and should be used as a singleton. It calls the underlying engine methods directly.
+ * Adds some function to the passed frame data object to let the user load the frame data.
  */
-declare class DataCaptureEngine<M extends Module> {
-    private static get3dPartyLicenseKeyMethodName;
-    context: DataCaptureContext$1;
-    lastUsedModuleMirrorAxis: unknown;
-    view: DataCaptureView | undefined;
-    hintPresenterV2: HintPresenterV2 | null;
-    protected readonly MAX_NUMBER_OF_IMAGES_IN_FRAME_DATA_POOL: number;
-    protected readonly moduleHandler: ModuleHandler<M>;
-    protected readonly redrawInterval: number;
-    protected readonly redrawRequests: number[];
-    protected readonly workerFunctions: WorkerFunctions;
-    protected _isDrawLoopRunning: boolean;
-    protected contextDeserializer: DataCaptureContextDeserializer | undefined;
-    protected frameDataPool: Map<number, {
-        data: Uint8ClampedArray;
-        colorType: ColorType;
-    }>;
-    protected lastFrameColorType: ColorType;
-    protected imageFrameSource?: DataCaptureImageBufferFrameSource;
-    protected lastFrameCounter: number;
-    protected libraryLoadingPromise: Promise<void> | undefined;
-    protected loopTimeoutId?: ReturnType<typeof setTimeout>;
-    protected resourcePath: string;
-    protected writableDataPath: string;
-    protected poorMansBenchmarkLogs: boolean;
-    protected parentDomain: string;
-    protected readonly writableDataPathStandard: string;
-    protected readonly resourceFilesSubfolder: string;
-    protected performanceMetricsReporterTimer: ReturnType<typeof setTimeout> | undefined;
-    protected performanceMetrics: PerformanceMetrics;
-    protected gestureRecognizer: GestureRecognizer | null;
-    private gestureListener;
-    private webPlatformHintPresenter;
-    private webImageConverterInstance;
-    constructor(moduleHandler: ModuleHandler<M>, workerFunctions: WorkerFunctions);
-    get Module(): M;
-    set isDrawLoopRunning(newValue: boolean);
-    get isDrawLoopRunning(): boolean;
-    convertToLoadableFrameData(frameData: WasmFrameData): PrivateLoadableFrameData;
-    createContext(createContextJSON: CreateContextParameters): EngineWorkerResponse<"createContext">;
-    convertToJPEGResult(imageId: number, result: Uint8Array): void;
-    /**
-     * Returns the ImageConverterInstance to be used in the worker thread. Depending on the availability of
-     * OffscreenCanvas, a different implementation is returned.
-     */
-    protected getImageConverterInstance(options: {
-        quality: number;
-    }): ImageConverterInstance;
-    onTap(point: PointJSON): void;
-    hintPresenterV2Update(): void;
-    startReportingPerformanceMetrics(): void;
-    reportPerformanceMetrics(): Promise<void>;
-    deleteFrameData(frameId: number): void;
-    dispose(): EngineWorkerResponse<"dispose">;
-    flushAnalytics(): void;
-    extractCentaurusLicense(scanditLicenseKey: string): EngineWorkerResponse<"extractCentaurusLicense">;
-    getModeDeserializers(): Vector;
-    loadLibrary(parameters: LoadLibraryParameters): EngineWorkerResponse<"loadLibrary">;
-    processFrame(parameters: ProcessFrameParameters): EngineWorkerResponse<"processFrame">;
-    reportCameraProperties(properties: ReportCameraPropertiesParameters): EngineWorkerResponse<"reportCameraProperties">;
-    requestFrameData(frameId: number): EngineWorkerResponse<"requestFrameData">;
-    scheduleRedraw(view: DataCaptureView, redrawInMs: number): void;
-    sendViewRefreshCommands(commands: Uint8Array): void;
-    setFrameSource(mirrorAxis: PrivateMirrorAxis, isCameraFrameSource: boolean): EngineWorkerResponse<"setFrameSource">;
-    /**
-     * The draw loop check at regular interval if any redraw request were made by the engine.
-     * If a redraw is necessary, it gathers and sends drawing commands to the main thread.
-     */
-    startDrawLoop(view: DataCaptureView): void;
-    updateContext(contextUpdateParameters: UpdateContextParameters): EngineWorkerResponse<"updateContext">;
-    /**
-     * Called before updateContextFromJson
-     *
-     * @protected
-     * @param {UpdateContextParameters} contextUpdateParameters
-     * @returns {UpdateContextParameters}
-     */
-    protected onBeforeUpdateContextHook(contextUpdateParameters: UpdateContextParameters): UpdateContextParameters;
-    onDocumentVisibilityChange(state: DocumentVisibilityState): void;
-    isFeatureSupported(feature: LicensedFeature): EngineWorkerResponse<"isFeatureSupported">;
-    getViewfinderInfo(): EngineWorkerResponse<"getViewfinderInfo">;
-    getOpenSourceSoftwareLicenseInfo(): EngineWorkerResponse<"getOpenSourceSoftwareLicenseInfo">;
-    protected getNextFrameId(): number;
-    protected getWasmDynamicLibraries(coreWasmURI: string): string[];
-    protected getWasmCoreExpectedHash(simdSupport: boolean, threadsSupport: boolean): string;
-    protected getWasmCoreFileName(simdSupport: boolean, threadsSupport: boolean): string;
-    protected getWasmMetadata(): Record<string, {
-        bytes: number;
-    }>;
-    protected getWasmSideModuleFileName(): string;
-    private _loadProgressCallback;
-    /**
-     * Redraw requests are scheduled at [now + redrawInMs], so when pushed they must be sorted
-     * in chronological order so that we can later easily check if we need to redraw by checking
-     * the first element.
-     * @param redrawInMs
-     */
-    private addRedrawRequest;
-    private contextDidChangeStatus;
-    private didStartObservingContext;
-    private mapMirrorAxisOnModule;
-    protected setView(view: DataCaptureView | undefined): void;
-    /**
-     * Add a native overlay to the view without passing from the deserializer.
-     * must be implemented in the specific module.
-     * @param event - The message event containing the overlay handle.
-     */
-    addNativeOverlay(event: MessageEvent<AnyDataCaptureActionMessage>): void;
-    /**
-     * Remove a native overlay from the view.
-     * must be implemented in the specific module.
-     * @param event - The message event containing the overlay handle.
-     */
-    removeNativeOverlay(event: MessageEvent<AnyDataCaptureActionMessage>): void;
-    private setViewRefreshHandler;
-    private setupDataDecoding;
-    private start;
-    private getWritableDataPath;
-    private numOfMBToPages;
-    private setup;
+declare function convertToPublicFrameData(loadableFrameData: PrivateLoadableFrameData, context: DataCaptureContext): FrameData;
+
+interface ModuleLoader {
+    moduleName: string;
+    load(options: ModuleLoaderOptions): Promise<any>;
 }
 
 type CommandAndPayload<A, C> = A extends {
@@ -1204,6 +1309,7 @@ declare class DataCaptureLoader {
     protected get name(): string;
     protected get fixedWasmMemory(): number | null;
     static create(options: DataCaptureLoaderOptions): Promise<DataCaptureLoader>;
+    private getIndexedDBTimeoutMs;
     load(): Promise<WorkerResponse<"loadLibrary">>;
     /**
      * Send a task (i.e. a command) to the worker. Every task sent has a corresponding Promise object which
@@ -1219,7 +1325,8 @@ declare class DataCaptureLoader {
 }
 
 declare enum HintPresenterEvents {
-    Update = "hintpresenterupdate"
+    Update = "hintpresenterupdate",
+    ViewFinderUpdateRequested = "hintpresenterviewfinderupdaterequested"
 }
 declare class HintPresenter extends ScanditHTMLElement {
     static readonly tag: "scandit-hints";
@@ -1227,8 +1334,6 @@ declare class HintPresenter extends ScanditHTMLElement {
     private root;
     private _viewFinderRect;
     private onDidToastHideHandler;
-    private orientationObserver;
-    private onOrientationChangeHandler;
     constructor();
     private static createStyleElement;
     static register(): void;
@@ -1247,8 +1352,12 @@ declare class HintPresenter extends ScanditHTMLElement {
     private hideGuidance;
     private startUpdateTimer;
     private stopUpdateTimer;
+    /**
+     * Whenever a toast is shown, we need to ensure that the view finder rect is set. If not, we dispatch an event to
+     * let the view know about it.
+     */
+    private ensureViewFinderRectIsSet;
     private idFromHint;
-    private onOrientationChange;
 }
 declare global {
     interface HTMLElementTagNameMap {
@@ -1285,7 +1394,6 @@ declare enum PrivateMirrorAxis {
 }
 
 type DataCaptureContextState = "unconfigured" | "configuring" | "configured" | "creating-context" | "ready";
-
 type Change = {
     type: "modeEnabled";
     newValue: boolean;
@@ -1571,4 +1679,4 @@ declare class DataCaptureContext implements Serializable<DataCaptureContextJSON>
     protected isFeatureSupported(feature: LicensedFeature): Promise<boolean>;
 }
 
-export { type WorkerResponse as $, convertToPublicFrameData as A, type ModuleLoader as B, type Control as C, type DataCaptureContextState as D, type DataCaptureLoaderOptions as E, type FrameData as F, DataCaptureLoader as G, HintPresenter as H, type PerformanceMetrics as I, DataCaptureEngine as J, type Module as K, type GenericHint as L, type ModuleLoaderOptions as M, type FrameCapture as N, type AnyDataCaptureActionMessage as O, type PrivateChangeSet as P, type AugmentedWorker as Q, type ModuleHandler as R, type DataCaptureCallbackMessage as S, type DataCaptureActionMessageKey as T, type EngineWorkerResponse as U, type ExtractCentaurusLicenseResponse as V, type WorkerFunctions as W, type RequestFrameDataResponse as X, type IsFeatureSupportedResponse as Y, type GetViewfinderInfo as Z, type GetOpenSourceSoftwareLicenseInfoResponse as _, type ControlType as a, type GuidanceHint as a$, type LoadLibraryDataCaptureAction as a0, type ConvertToJPEGResultDataCaptureAction as a1, type CreateContextDataCaptureAction as a2, type SetFrameSourceDataCaptureAction as a3, type ProcessFrameDataCaptureAction as a4, type RequestFrameDataDataCaptureAction as a5, type DeleteFrameDataDataCaptureAction as a6, type VisibilityChangeAction as a7, type IsFeatureSupportedAction as a8, type UpdateContextDataCaptureAction as a9, type StartUpdateTimerMessage as aA, type StopUpdateTimerMessage as aB, type PayloadForCommand as aC, type DataCaptureWorker as aD, type EmscriptenClassHandle as aE, type DataCaptureContext$1 as aF, type DataCaptureImageBufferFrameSource as aG, type GestureListener as aH, type GestureRecognizer as aI, type DataCaptureView as aJ, type JSONParseable as aK, type DataCaptureContextDeserializerResult as aL, type DataCaptureContextDeserializer as aM, type CaptureModeDeserializerInstance as aN, type ModuleMirrorAxis as aO, type Vector as aP, type WasmFrameData as aQ, HintFont as aR, HintTextAlignment as aS, HintWidth as aT, HintHeight as aU, HintCornerStyle as aV, HintIcon as aW, HintAnchor as aX, type HintStyle as aY, GuidanceHintAnchor as aZ, GuidanceHintStyle as a_, type DisposeDataCaptureAction as aa, type FlushAnalyticsDataCaptureAction as ab, type ReportCameraPropertiesDataCaptureAction as ac, type SetLogLevelDataCaptureAction as ad, type ExtractCentaurusLicenseDataCaptureAction as ae, type OnTapAction as af, type HintPresenterV2updateAction as ag, type GetViewfinderInfoAction as ah, type GetOpenSourceSoftwareLicenseInfoAction as ai, type AddNativeOverlayAction as aj, type RemoveNativeOverlayAction as ak, type DataCaptureCallbackMessageKeys as al, type SuccessFeedbackWorkerMessage as am, type ShowHintWorkerMessage as an, type UpdateHintWorkerMessage as ao, type IsFeatureSupportedMessage as ap, type HideHintWorkerMessage as aq, type PerformanceMetricsReportMessage as ar, type DidTapTrackedBarcode as as, type OnFrameProcessingStartedMessage as at, type OnFrameProcessingFinishedMessage as au, type OnFrameSkippedMessage as av, type ShowToastMessage as aw, type HideToastMessage as ax, type ShowGuidanceMessage as ay, type HideGuidanceMessage as az, type Change as b, ToastHintStyle as b0, type ToastHint as b1, LicensedFeature as b2, type HintPresenterV2 as b3, type PlatformHintPresenter as b4, type LoadLibraryParameters as b5, type CreateContextParameters as b6, type UpdateContextParameters as b7, type SetFrameSourceParameters as b8, type ProcessFrameParameters as b9, type ReportCameraPropertiesParameters as ba, type PrivateBaseControl as bb, type PrivateControl as bc, MeteringMode as bd, CameraResolutionConstraint as be, type ExtendedMediaTrackCapabilities as bf, type ExtendedMediaTrackConstraintSet as bg, type GUI as bh, CameraManagerEvent as bi, type CameraManagerEventParameters as bj, CameraManager as bk, HintPresenterEvents as bl, type DataCaptureMode as c, type PrivateDataCaptureMode as d, type DataCaptureModeJSON as e, type PrivateDataCaptureComponent as f, type DataCaptureComponentJSON as g, type DataCaptureComponent as h, type PrivateDataCaptureContextOptions as i, type PrivateDataCaptureContext as j, type DataCaptureContextCreationOptions as k, type PrivateCapabilityInfo as l, type DataCaptureContextJSON as m, type PrivateFrameHandlerResponse as n, type PrivateFrameHandler as o, DataCaptureContext as p, type DataCaptureContextListener as q, type ContextStatusJSON as r, ContextStatus as s, PrivateMirrorAxis as t, type DataCaptureOverlay as u, type DataCaptureViewListener as v, type DataCaptureViewJSON as w, type DataCaptureViewConnectOptions as x, DataCaptureView$1 as y, type PrivateLoadableFrameData as z };
+export { type GetViewfinderInfoResponse as $, convertToPublicFrameData as A, type ModuleLoader as B, type Control as C, type DataCaptureContextState as D, type DataCaptureLoaderOptions as E, type FrameData as F, DataCaptureLoader as G, HintPresenter as H, type PerformanceMetrics as I, type FrameId as J, DataCaptureEngine as K, type Module as L, type ModuleLoaderOptions as M, type GenericHint as N, type FrameCapture as O, type PrivateChangeSet as P, type AnyDataCaptureActionMessage as Q, type AugmentedWorker as R, type ModuleHandler as S, type DataCaptureCallbackMessage as T, type DataCaptureActionMessageKey as U, type ViewInfo as V, type WorkerFunctions as W, type EngineWorkerResponse as X, type ExtractCentaurusLicenseResponse as Y, type RequestFrameDataResponse as Z, type IsFeatureSupportedResponse as _, type ControlType as a, type HintStyle as a$, type GetOpenSourceSoftwareLicenseInfoResponse as a0, type WorkerResponse as a1, type LoadLibraryDataCaptureAction as a2, type ConvertToJPEGResultDataCaptureAction as a3, type CreateContextDataCaptureAction as a4, type SetFrameSourceDataCaptureAction as a5, type ProcessFrameDataCaptureAction as a6, type RequestFrameDataDataCaptureAction as a7, type DeleteFrameDataDataCaptureAction as a8, type VisibilityChangeAction as a9, type ShowGuidanceMessage as aA, type HideGuidanceMessage as aB, type StartUpdateTimerMessage as aC, type StopUpdateTimerMessage as aD, type ViewSizeChangedMessage as aE, type PayloadForCommand as aF, type DataCaptureWorker as aG, type EmscriptenClassHandle as aH, type DataCaptureContext$1 as aI, type DataCaptureImageBufferFrameSource as aJ, type GestureListener as aK, type GestureRecognizer as aL, type DataCaptureView as aM, type JSONParseable as aN, type DataCaptureContextDeserializerResult as aO, type DataCaptureContextDeserializer as aP, type CaptureModeDeserializerInstance as aQ, type ModuleMirrorAxis as aR, type Vector as aS, type WasmFrameData as aT, HintFont as aU, HintTextAlignment as aV, HintWidth as aW, HintHeight as aX, HintCornerStyle as aY, HintIcon as aZ, HintAnchor as a_, type IsFeatureSupportedAction as aa, type UpdateContextDataCaptureAction as ab, type DisposeDataCaptureAction as ac, type FlushAnalyticsDataCaptureAction as ad, type ReportCameraPropertiesDataCaptureAction as ae, type SetLogLevelDataCaptureAction as af, type ExtractCentaurusLicenseDataCaptureAction as ag, type OnTapAction as ah, type HintPresenterV2updateAction as ai, type GetViewfinderInfoAction as aj, type GetOpenSourceSoftwareLicenseInfoAction as ak, type AddNativeOverlayAction as al, type RemoveNativeOverlayAction as am, type DataCaptureCallbackMessageKeys as an, type SuccessFeedbackWorkerMessage as ao, type ShowHintWorkerMessage as ap, type UpdateHintWorkerMessage as aq, type IsFeatureSupportedMessage as ar, type HideHintWorkerMessage as as, type PerformanceMetricsReportMessage as at, type DidTapTrackedBarcode as au, type OnFrameProcessingStartedMessage as av, type OnFrameProcessingFinishedMessage as aw, type OnFrameSkippedMessage as ax, type ShowToastMessage as ay, type HideToastMessage as az, type Change as b, GuidanceHintAnchor as b0, GuidanceHintStyle as b1, type GuidanceHint as b2, ToastHintStyle as b3, type ToastHint as b4, LicensedFeature as b5, type HintPresenterV2 as b6, type PlatformHintPresenter as b7, type LoadLibraryParameters as b8, type CreateContextParameters as b9, type UpdateContextParameters as ba, type SetFrameSourceParameters as bb, type ProcessFrameParameters as bc, type ReportCameraPropertiesParameters as bd, type PrivateBaseControl as be, type PrivateControl as bf, MeteringMode as bg, CameraResolutionConstraint as bh, type ExtendedMediaTrackCapabilities as bi, type ExtendedMediaTrackConstraintSet as bj, type GUI as bk, createFrameId as bl, CameraManagerEvent as bm, type CameraManagerEventParameters as bn, CameraManager as bo, HintPresenterEvents as bp, type DataCaptureMode as c, type PrivateDataCaptureMode as d, type DataCaptureModeJSON as e, type PrivateDataCaptureComponent as f, type DataCaptureComponentJSON as g, type DataCaptureComponent as h, type PrivateDataCaptureContextOptions as i, type PrivateDataCaptureContext as j, type DataCaptureContextCreationOptions as k, type PrivateCapabilityInfo as l, type DataCaptureContextJSON as m, type PrivateFrameHandlerResponse as n, type PrivateFrameHandler as o, DataCaptureContext as p, type DataCaptureContextListener as q, type ContextStatusJSON as r, ContextStatus as s, PrivateMirrorAxis as t, type DataCaptureOverlay as u, type DataCaptureViewListener as v, type DataCaptureViewJSON as w, type DataCaptureViewConnectOptions as x, DataCaptureView$1 as y, type PrivateLoadableFrameData as z };