/** * Copyright (c) Microblink Ltd. All rights reserved. */ import { BlinkIdCombinedRecognizer, BlinkIdCombinedRecognizerResult, BlinkIdCombinedRecognizerSettings, BlinkIdRecognizer, BlinkIdRecognizerSettings, createBlinkIdCombinedRecognizer, createBlinkIdRecognizer, createIdBarcodeRecognizer, IdBarcodeRecognizer, IdBarcodeRecognizerSettings, Recognizer, RecognizerResult, SelectedCamera, SignedPayload, SuccessFrameGrabberRecognizer, SuccessFrameGrabberRecognizerResult, WasmSDK, WasmSDKLoadSettings } from "@microblink/docver-in-browser-sdk"; export { ProductIntegrationInfo, SDKError, } from "@microblink/docver-in-browser-sdk"; export declare type SdkSettings = Pick; export declare type AvailableRecognizer = IdBarcodeRecognizer | BlinkIdRecognizer | BlinkIdCombinedRecognizer; export declare type AvailableRecognizerName = "IdBarcodeRecognizer" | "BlinkIdRecognizer" | "BlinkIdCombinedRecognizer"; export declare type RecognizerOptions = Partial; /** * Optional flag for internal usage */ export declare type ExtendedRecognizerOptions = RecognizerOptions & { returnSignedJSON?: boolean; }; /** * Events */ export declare type EventReady = { sdk: WasmSDK; }; export declare type EventScanError = { code: Code; fatal: boolean; message: string; recognizerName?: AvailableRecognizerName; details?: any; }; export declare type EventScanSuccess = { result: T; recognizerName: AvailableRecognizerName; successFrame?: SuccessFrameGrabberRecognizerResult; }; export interface RecognitionResults { result: RecognizerResult; successFrame?: SuccessFrameGrabberRecognizerResult; } /** * Error codes */ export declare enum Code { EmptyResult = "EMPTY_RESULT", InvalidRecognizerOptions = "INVALID_RECOGNIZER_OPTIONS", NoImageFileFound = "NO_IMAGE_FILE_FOUND", NoFirstImageFileFound = "NO_FIRST_IMAGE_FILE_FOUND", NoSecondImageFileFound = "NO_SECOND_IMAGE_FILE_FOUND", GenericScanError = "GENERIC_SCAN_ERROR", CameraNotAllowed = "CAMERA_NOT_ALLOWED", CameraInUse = "CAMERA_IN_USE", CameraGenericError = "CAMERA_GENERIC_ERROR" } /** * Scan structures */ export declare const getRecognizerCreator: { readonly IdBarcodeRecognizer: typeof createIdBarcodeRecognizer; readonly BlinkIdRecognizer: typeof createBlinkIdRecognizer; readonly BlinkIdCombinedRecognizer: typeof createBlinkIdCombinedRecognizer; }; export interface VideoRecognitionConfiguration { recognizers: Array; recognizerOptions?: ExtendedRecognizerOptions; recognitionTimeout?: number; successFrame: boolean; cameraFeed: HTMLVideoElement; cameraId: string | null; } export interface ImageRecognitionConfiguration { recognizers: Array; recognizerOptions?: ExtendedRecognizerOptions; thoroughScan?: boolean; file: File; } export interface CombinedImageRecognitionConfiguration { recognizers: Array; recognizerOptions?: ExtendedRecognizerOptions; thoroughScan?: boolean; firstFile: File; secondFile: File; } export declare enum ImageRecognitionType { Single = "Single", Combined = "Combined" } export declare enum CombinedImageType { First = "First", Second = "Second" } export interface RecognizerInstance { name: string; recognizer: Recognizer & { objectHandle: number; }; successFrame?: SuccessFrameGrabberRecognizer & { objectHandle?: number; }; } export declare enum RecognitionStatus { NoImageFileFound = "NoImageFileFound", NoFirstImageFileFound = "NoFirstImageFileFound", NoSecondImageFileFound = "NoSecondImageFileFound", Preparing = "Preparing", Ready = "Ready", Processing = "Processing", DetectionFailed = "DetectionFailed", EmptyResultState = "EmptyResultState", OnFirstSideResult = "OnFirstSideResult", ScanSuccessful = "ScanSuccessful", DocumentClassified = "DocumentClassified", DetectionStatusChange = "DetectionStatusChange", NoSupportForMediaDevices = "NoSupportForMediaDevices", CameraNotFound = "CameraNotFound", CameraNotAllowed = "CameraNotAllowed", UnableToAccessCamera = "UnableToAccessCamera", CameraInUse = "CameraInUse", CameraGenericError = "CameraGenericError", UnknownError = "UnknownError", BarcodeScanningStarted = "BarcodeScanningStarted", DetectionStatusFail = "Fail", DetectionStatusSuccess = "Success", DetectionStatusCameraTooHigh = "CameraTooHigh", DetectionStatusFallbackSuccess = "FallbackSuccess", DetectionStatusPartial = "Partial", DetectionStatusCameraAtAngle = "CameraAtAngle", DetectionStatusCameraTooNear = "CameraTooNear", DetectionStatusDocumentTooCloseToEdge = "DocumentTooCloseToEdge" } export interface RecognitionEvent { status: RecognitionStatus; data?: any; } export interface RecognitionResults { result: RecognizerResult; recognizerName: string; successFrame?: SuccessFrameGrabberRecognizerResult; imageCapture?: boolean; resultSignedJSON?: SignedPayload; } export declare enum CameraExperience { Barcode = "BARCODE", CardCombined = "CARD_COMBINED", CardSingleSide = "CARD_SINGLE_SIDE", PaymentCard = "PAYMENT_CARD" } export declare enum CameraExperienceState { BarcodeScanning = "BarcodeScanning", AdjustAngle = "AdjustAngle", Classification = "Classification", Default = "Default", Detection = "Detection", Done = "Done", DoneAll = "DoneAll", Flip = "Flip", MoveCloser = "MoveCloser", MoveFarther = "MoveFarther" } export interface CameraExperienceTimeoutDurations { barcodeScanning: number; adjustAngle: number; default: number; done: number; doneAll: number; flip: number; moveCloser: number; moveFarther: number; } export declare const CameraExperienceStateDuration: Map; /** * User feedback structures */ export declare enum FeedbackCode { CameraDisabled = "CAMERA_DISABLED", CameraGenericError = "CAMERA_GENERIC_ERROR", CameraInUse = "CAMERA_IN_USE", CameraNotAllowed = "CAMERA_NOT_ALLOWED", GenericScanError = "GENERIC_SCAN_ERROR", ScanStarted = "SCAN_STARTED", ScanUnsuccessful = "SCAN_UNSUCCESSFUL", ScanSuccessful = "SCAN_SUCCESSFUL" } export interface FeedbackMessage { code?: FeedbackCode; state: "FEEDBACK_ERROR" | "FEEDBACK_INFO" | "FEEDBACK_OK"; message: string; } /** * Camera selection */ export interface CameraEntry { prettyName: string; details: SelectedCamera | null; }