|
| 1 | +import { DSImageData, EngineResourcePaths } from 'dynamsoft-core'; |
| 2 | +export * from 'dynamsoft-core'; |
| 3 | +export * from 'dynamsoft-license'; |
| 4 | +import { CapturedResult, CaptureVisionRouter } from 'dynamsoft-capture-vision-router'; |
| 5 | +export * from 'dynamsoft-capture-vision-router'; |
| 6 | +import { CameraEnhancer, CameraView } from 'dynamsoft-camera-enhancer'; |
| 7 | +export * from 'dynamsoft-camera-enhancer'; |
| 8 | +export * from 'dynamsoft-label-recognizer'; |
| 9 | +export * from 'dynamsoft-code-parser'; |
| 10 | +export * from 'dynamsoft-utility'; |
| 11 | + |
| 12 | +declare enum EnumMRZScanMode { |
| 13 | + Passport = "passport", |
| 14 | + TD1 = "td1", |
| 15 | + TD2 = "td2", |
| 16 | + PassportAndTD1 = "passportAndTd1", |
| 17 | + PassportAndTD2 = "passportAndTd2", |
| 18 | + TD1AndTD2 = "td1AndTd2", |
| 19 | + All = "all" |
| 20 | +} |
| 21 | +declare enum EnumMRZDocumentType { |
| 22 | + Passport = "passport", |
| 23 | + TD1 = "td1", |
| 24 | + TD2 = "td2" |
| 25 | +} |
| 26 | +declare enum EnumMRZScannerViews { |
| 27 | + Scanner = "scanner", |
| 28 | + Result = "scan-result" |
| 29 | +} |
| 30 | +declare const DEFAULT_TEMPLATE_NAMES: { |
| 31 | + passport: string; |
| 32 | + td1: string; |
| 33 | + td2: string; |
| 34 | + passportAndTd1: string; |
| 35 | + passportAndTd2: string; |
| 36 | + td1AndTd2: string; |
| 37 | + all: string; |
| 38 | +}; |
| 39 | +type UtilizedTemplateNames = Record<EnumMRZScanMode, string>; |
| 40 | +declare enum EnumResultStatus { |
| 41 | + RS_SUCCESS = 0, |
| 42 | + RS_CANCELLED = 1, |
| 43 | + RS_FAILED = 2 |
| 44 | +} |
| 45 | +type ResultStatus = { |
| 46 | + code: EnumResultStatus; |
| 47 | + message?: string; |
| 48 | +}; |
| 49 | +type ToolbarButtonConfig = Pick<ToolbarButton, "icon" | "label" | "className" | "isHidden">; |
| 50 | +interface ToolbarButton { |
| 51 | + id: string; |
| 52 | + icon: string; |
| 53 | + label: string; |
| 54 | + onClick?: () => void | Promise<void>; |
| 55 | + className?: string; |
| 56 | + isDisabled?: boolean; |
| 57 | + isHidden?: boolean; |
| 58 | +} |
| 59 | + |
| 60 | +declare enum EnumMRZData { |
| 61 | + InvalidFields = "invalidFields", |
| 62 | + DocumentType = "documentType", |
| 63 | + DocumentNumber = "documentNumber", |
| 64 | + MRZText = "mrzText", |
| 65 | + FirstName = "firstName", |
| 66 | + LastName = "lastName", |
| 67 | + Age = "age", |
| 68 | + Sex = "sex", |
| 69 | + IssuingState = "issuingState", |
| 70 | + Nationality = "nationality", |
| 71 | + DateOfBirth = "dateOfBirth", |
| 72 | + DateOfExpiry = "dateOfExpiry" |
| 73 | +} |
| 74 | +interface MRZResult { |
| 75 | + status: ResultStatus; |
| 76 | + originalImageResult?: DSImageData; |
| 77 | + data?: MRZData; |
| 78 | + _imageData?: DSImageData; |
| 79 | +} |
| 80 | +interface MRZData { |
| 81 | + [EnumMRZData.InvalidFields]?: EnumMRZData[]; |
| 82 | + [EnumMRZData.DocumentType]: string; |
| 83 | + [EnumMRZData.DocumentNumber]: string; |
| 84 | + [EnumMRZData.MRZText]: string; |
| 85 | + [EnumMRZData.FirstName]: string; |
| 86 | + [EnumMRZData.LastName]: string; |
| 87 | + [EnumMRZData.Age]: number; |
| 88 | + [EnumMRZData.Sex]: string; |
| 89 | + [EnumMRZData.IssuingState]: string; |
| 90 | + [EnumMRZData.Nationality]: string; |
| 91 | + [EnumMRZData.DateOfBirth]: MRZDate; |
| 92 | + [EnumMRZData.DateOfExpiry]: MRZDate; |
| 93 | +} |
| 94 | +interface MRZDate { |
| 95 | + year: number; |
| 96 | + month: number; |
| 97 | + day: number; |
| 98 | +} |
| 99 | +declare const MRZDataLabel: Record<EnumMRZData, string>; |
| 100 | +declare function displayMRZDate(date: MRZDate): string; |
| 101 | + |
| 102 | +declare enum _DEMO_VIRTUAL_CAMERA_LIST { |
| 103 | + VIRTUAL_PASSPORT = "virtual1", |
| 104 | + VIRTUAL_TD1 = "virtual2", |
| 105 | + VIRTUAL_TD2 = "virtual3", |
| 106 | + PHYSICAL_CAMERA = "camera" |
| 107 | +} |
| 108 | +type _DEMO_CameraType = _DEMO_VIRTUAL_CAMERA_LIST; |
| 109 | +interface MRZScannerViewConfig { |
| 110 | + cameraEnhancerUIPath?: string; |
| 111 | + container?: HTMLElement | string; |
| 112 | + templateFilePath?: string; |
| 113 | + utilizedTemplateNames?: UtilizedTemplateNames; |
| 114 | + mrzFormatType?: EnumMRZDocumentType | Array<EnumMRZDocumentType>; |
| 115 | + showScanGuide?: boolean; |
| 116 | + showUploadImage?: boolean; |
| 117 | + showFormatSelector?: boolean; |
| 118 | + showSoundToggle?: boolean; |
| 119 | + enableMultiFrameCrossFilter?: boolean; |
| 120 | +} |
| 121 | +declare class MRZScannerView { |
| 122 | + private resources; |
| 123 | + private config; |
| 124 | + private demoScanningMode; |
| 125 | + private demoScanningResolution; |
| 126 | + private isSoundFeedbackOn; |
| 127 | + private scanModeManager; |
| 128 | + private currentScanMode; |
| 129 | + private resizeTimer; |
| 130 | + private capturedResultItems; |
| 131 | + private originalImageData; |
| 132 | + private initialized; |
| 133 | + private initializedDCE; |
| 134 | + private DCE_ELEMENTS; |
| 135 | + private currentScanResolver?; |
| 136 | + private loadingScreen; |
| 137 | + private showScannerLoadingOverlay; |
| 138 | + private hideScannerLoadingOverlay; |
| 139 | + private handleResize; |
| 140 | + constructor(resources: SharedResources, config: MRZScannerViewConfig); |
| 141 | + initialize(): Promise<void>; |
| 142 | + private initializeElements; |
| 143 | + private setupScanModeSelector; |
| 144 | + private assignDCEClickEvents; |
| 145 | + private handleCloseBtn; |
| 146 | + private attachOptionClickListeners; |
| 147 | + private _demo_AttachFakeEventsToCameras; |
| 148 | + private _demo_CheckForFakeCamera; |
| 149 | + private highlightCameraAndResolutionOption; |
| 150 | + private toggleSelectCameraBox; |
| 151 | + private get _demo_IsFirefoxAndroid(); |
| 152 | + private _demo_saveSelectedCamera; |
| 153 | + private _demo_AddFakeCameras; |
| 154 | + private uploadImage; |
| 155 | + private toggleSoundFeedback; |
| 156 | + private calculateScanRegion; |
| 157 | + private toggleScanGuide; |
| 158 | + openCamera(_demo_cameraType?: _DEMO_CameraType): Promise<void>; |
| 159 | + private _demo_playVideoWithRes; |
| 160 | + closeCamera(hideContainer?: boolean): Promise<void>; |
| 161 | + pauseCamera(): void; |
| 162 | + stopCapturing(): void; |
| 163 | + handleMRZResult(result: CapturedResult): Promise<void>; |
| 164 | + private initializeScanModeManager; |
| 165 | + private getScanMode; |
| 166 | + private DCEShowToast; |
| 167 | + private startCapturing; |
| 168 | + private toggleScanDocType; |
| 169 | + launch(_demo_cameraType?: _DEMO_CameraType): Promise<MRZResult>; |
| 170 | +} |
| 171 | + |
| 172 | +interface MRZResultViewToolbarButtonsConfig { |
| 173 | + rescan?: ToolbarButtonConfig; |
| 174 | + done?: ToolbarButtonConfig; |
| 175 | +} |
| 176 | +interface MRZResultViewConfig { |
| 177 | + container?: HTMLElement | string; |
| 178 | + toolbarButtonsConfig?: MRZResultViewToolbarButtonsConfig; |
| 179 | + showOriginalImage?: boolean; |
| 180 | + showMRZText?: boolean; |
| 181 | + allowResultEditing?: boolean; |
| 182 | + onDone?: (result: MRZResult) => Promise<void>; |
| 183 | +} |
| 184 | +declare class MRZResultView { |
| 185 | + private resources; |
| 186 | + private config; |
| 187 | + private scannerView; |
| 188 | + private currentScanResultViewResolver?; |
| 189 | + private editedFields; |
| 190 | + constructor(resources: SharedResources, config: MRZResultViewConfig, scannerView: MRZScannerView); |
| 191 | + launch(): Promise<MRZResult>; |
| 192 | + private handleRescan; |
| 193 | + private handleDone; |
| 194 | + private createControls; |
| 195 | + private handleFieldEdit; |
| 196 | + private createMRZDataDisplay; |
| 197 | + initialize(): Promise<void>; |
| 198 | + hideView(): void; |
| 199 | + dispose(preserveResolver?: boolean): void; |
| 200 | +} |
| 201 | + |
| 202 | +interface MRZScannerConfig { |
| 203 | + license?: string; |
| 204 | + container?: HTMLElement | string; |
| 205 | + templateFilePath?: string; |
| 206 | + utilizedTemplateNames?: UtilizedTemplateNames; |
| 207 | + engineResourcePaths?: EngineResourcePaths; |
| 208 | + scannerViewConfig?: Omit<MRZScannerViewConfig, "templateFilePath" | "utilizedTemplateNames">; |
| 209 | + resultViewConfig?: MRZResultViewConfig; |
| 210 | + mrzFormatType?: Array<EnumMRZDocumentType>; |
| 211 | + showResultView?: boolean; |
| 212 | +} |
| 213 | +interface SharedResources { |
| 214 | + cvRouter?: CaptureVisionRouter; |
| 215 | + cameraEnhancer?: CameraEnhancer; |
| 216 | + cameraView?: CameraView; |
| 217 | + result?: MRZResult; |
| 218 | + onResultUpdated?: (result: MRZResult) => void; |
| 219 | +} |
| 220 | +declare class MRZScanner { |
| 221 | + private config; |
| 222 | + private scannerView?; |
| 223 | + private resultView?; |
| 224 | + private resources; |
| 225 | + private isInitialized; |
| 226 | + private isCapturing; |
| 227 | + private loadingScreen; |
| 228 | + private showLoadingOverlay; |
| 229 | + private hideLoadingOverlay; |
| 230 | + constructor(config: MRZScannerConfig); |
| 231 | + initialize(): Promise<{ |
| 232 | + resources: SharedResources; |
| 233 | + components: { |
| 234 | + scannerView?: MRZScannerView; |
| 235 | + resultView?: MRZResultView; |
| 236 | + }; |
| 237 | + }>; |
| 238 | + private initializeDCVResources; |
| 239 | + private shouldCreateDefaultContainer; |
| 240 | + private createDefaultMRZScannerContainer; |
| 241 | + private checkForTemporaryLicense; |
| 242 | + private validateViewConfigs; |
| 243 | + private showResultView; |
| 244 | + private initializeMRZScannerConfig; |
| 245 | + private createViewContainers; |
| 246 | + dispose(): void; |
| 247 | + launch(_demo_cameraType?: _DEMO_CameraType): Promise<MRZResult>; |
| 248 | +} |
| 249 | + |
| 250 | +declare const DynamsoftMRZScanner: { |
| 251 | + MRZScanner: typeof MRZScanner; |
| 252 | + MRZScannerView: typeof MRZScannerView; |
| 253 | + MRZResultView: typeof MRZResultView; |
| 254 | +}; |
| 255 | + |
| 256 | +export { DEFAULT_TEMPLATE_NAMES, DynamsoftMRZScanner, EnumMRZData, EnumMRZDocumentType, EnumMRZScanMode, EnumMRZScannerViews, EnumResultStatus, MRZData, MRZDataLabel, MRZDate, MRZResult, MRZResultView, MRZResultViewConfig, MRZResultViewToolbarButtonsConfig, MRZScanner, MRZScannerView, MRZScannerViewConfig, ResultStatus, ToolbarButton, ToolbarButtonConfig, UtilizedTemplateNames, displayMRZDate }; |
0 commit comments