scanbot-web-sdk 6.0.0-dev.6 → 7.0.0-dev.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/@types/barcode-scanner-view.d.ts +1 -1
- package/@types/core/bridge/compiled/{BarcodeConfigs.d.ts → BarcodeConfigurationTypes.d.ts} +558 -173
- package/@types/core/bridge/compiled/BarcodeDocumentModel.d.ts +1421 -0
- package/@types/core/bridge/compiled/BarcodeDocumentTypes.d.ts +14 -13
- package/@types/core/bridge/compiled/BarcodeScannerTypes.d.ts +25 -14
- package/@types/core/bridge/compiled/BarcodeTypes.d.ts +58 -56
- package/@types/core/bridge/compiled/CheckDocumentModel.d.ts +130 -0
- package/@types/core/bridge/compiled/CheckScannerTypes.d.ts +67 -0
- package/@types/core/bridge/compiled/CommonFieldType.d.ts +29 -28
- package/@types/core/bridge/compiled/CreditCardDocumentModel.d.ts +16 -0
- package/@types/core/bridge/compiled/CreditCardTypes.d.ts +35 -33
- package/@types/core/bridge/compiled/DocumentDataExtractorConfigurationTypes.d.ts +148 -0
- package/@types/core/bridge/compiled/DocumentDataExtractorTypes.d.ts +90 -0
- package/@types/core/bridge/compiled/DocumentQualityAnalyzerTypes.d.ts +28 -23
- package/@types/core/bridge/compiled/{DocumentDetectorTypes.d.ts → DocumentScannerTypes.d.ts} +49 -47
- package/@types/core/bridge/compiled/DocumentsModel.d.ts +489 -0
- package/@types/core/bridge/compiled/{EhicTypes.d.ts → EuropeanHealthInsuranceCardTypes.d.ts} +51 -108
- package/@types/core/bridge/compiled/FrameAccumulationTypes.d.ts +37 -14
- package/@types/core/bridge/compiled/GenericDocument.d.ts +17 -17
- package/@types/core/bridge/compiled/Geometry.d.ts +2 -2
- package/@types/core/bridge/compiled/ImageTypes.d.ts +1 -0
- package/@types/core/bridge/compiled/LicensePlateScannerTypes.d.ts +20 -19
- package/@types/core/bridge/compiled/MedicalCertificateTypes.d.ts +108 -105
- package/@types/core/bridge/compiled/MrzTypes.d.ts +73 -0
- package/@types/core/bridge/compiled/ParametricFilters.d.ts +4 -3
- package/@types/core/bridge/compiled/{PdfConfig.d.ts → PdfConfigurationTypes.d.ts} +48 -45
- package/@types/core/bridge/compiled/{GenericTextLineScannerTypes.d.ts → TextPatternScannerTypes.d.ts} +20 -39
- package/@types/core/bridge/compiled/TiffTypes.d.ts +48 -50
- package/@types/core/bridge/compiled/VinScannerTypes.d.ts +79 -0
- package/@types/core/bridge/worker-bridge.d.ts +512 -374
- package/@types/core/worker/ScanbotSDK.Core.d.ts +28 -22
- package/@types/core-types.d.ts +15 -12
- package/@types/cropping-view.d.ts +8 -4
- package/@types/document-data-extractor-view.d.ts +22 -0
- package/@types/document-scanner-view.d.ts +16 -7
- package/@types/index.d.ts +37 -24
- package/@types/interfaces/i-cropping-view-handle.d.ts +2 -0
- package/@types/interfaces/i-document-data-extractor-scanner-handle.d.ts +3 -0
- package/@types/interfaces/{i-text-data-scanner-handle.d.ts → i-text-pattern-scanner-handle.d.ts} +1 -1
- package/@types/model/configuration/barcode-scanner-configuration.d.ts +1 -0
- package/@types/model/configuration/cropping-view-configuration.d.ts +1 -0
- package/@types/model/configuration/document-data-extractor-configuration.d.ts +9 -0
- package/@types/model/configuration/document-scanner-configuration.d.ts +8 -4
- package/@types/model/configuration/initialization-options.d.ts +1 -2
- package/@types/model/configuration/mrz-scanner-configuration.d.ts +4 -4
- package/@types/model/configuration/selection-overlay-configuration.d.ts +5 -0
- package/@types/model/configuration/text-pattern-scanner-configuration.d.ts +9 -0
- package/@types/model/configuration/view-finder-scanner-configuration.d.ts +2 -1
- package/@types/model/configuration/vin-scanner-configuration.d.ts +4 -4
- package/@types/scanbot-sdk.d.ts +276 -210
- package/@types/scanner-view.d.ts +2 -0
- package/@types/service/document-data-extractor.d.ts +13 -0
- package/@types/service/ocr-engine.d.ts +3 -3
- package/@types/service/pdf-generator.d.ts +6 -1
- package/@types/service/simple-mrz-recognizer.d.ts +4 -4
- package/@types/service/storage/indexed-db/sb-indexed-db.d.ts +60 -0
- package/@types/service/storage/local/sb-local-storage.d.ts +11 -0
- package/@types/service/storage/sb-storage.d.ts +33 -0
- package/@types/service/storage/utils/create-worker-vite.d.ts +1 -0
- package/@types/service/storage/utils/create-worker.d.ts +1 -0
- package/@types/service/storage/utils/sb-storage-error.d.ts +5 -0
- package/@types/service/storage/utils/sb-storage-utils.d.ts +10 -0
- package/@types/service/text-pattern-scanner.d.ts +14 -0
- package/@types/service/tiff-generator.d.ts +7 -4
- package/@types/service/vin-scanner.d.ts +16 -0
- package/@types/{text-data-scanner-view.d.ts → text-pattern-scanner-view.d.ts} +10 -10
- package/@types/ui2/{controllers → barcode/controllers}/barcode-scanner-controller.d.ts +1 -1
- package/@types/ui2/{controllers → barcode/controllers}/multiple-scanning-mode-controller.d.ts +1 -1
- package/@types/ui2/{controllers → barcode/controllers}/single-scanning-mode-controller.d.ts +1 -1
- package/@types/ui2/{model → barcode/model}/counted-barcodes.d.ts +2 -2
- package/@types/ui2/{utils → barcode/utils}/barcode-mapper/expected-barcode-mapper.d.ts +2 -2
- package/@types/ui2/{utils → barcode/utils}/barcode-mapper/i-barcode-mapper.d.ts +2 -2
- package/@types/ui2/{utils → barcode/utils}/barcode-mapper/user-barcode-mapper.d.ts +1 -1
- package/@types/ui2/{utils → barcode/utils}/camera-config.d.ts +2 -2
- package/@types/ui2/{utils → barcode/utils}/styled-badge.d.ts +3 -1
- package/@types/ui2/{utils → barcode/utils}/styled-box.d.ts +1 -1
- package/@types/ui2/barcode/utils/styled-button.d.ts +14 -0
- package/@types/ui2/{utils → barcode/utils}/useScanningViewSize.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/action-button/action-button-container.d.ts +3 -3
- package/@types/ui2/{views → barcode/views}/action-button/action-button.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/ar/ar-badge.d.ts +2 -2
- package/@types/ui2/{views → barcode/views}/ar/ar-overlay-barcode-info.d.ts +2 -2
- package/@types/ui2/{views → barcode/views}/ar/vertical-positions.d.ts +2 -2
- package/@types/ui2/{views → barcode/views}/barcode-info/barcode-info.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/barcode-scanner.d.ts +8 -8
- package/@types/ui2/{views → barcode/views}/camera-permission-denied.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/dialog/barcode-info-dialog.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/dialog/barcode-mapping-error-dialog.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/dialog/base/confirmation-dialog.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/dialog/base/styled-dialog.d.ts +1 -0
- package/@types/ui2/{views → barcode/views}/dialog/count-edit-dialog.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/dialog/find-and-pick-submit-dialog.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/barcode-result-drawer.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/barcode-result-sidebar.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/counting-button.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/hooks/use-drag-listener.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-drawer-empty-state.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-list-item.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-list.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/subviews/drawer-header-content.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/drawer/subviews/swipe-underlay.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/form/dialog-button.d.ts +4 -1
- package/@types/ui2/{views → barcode/views}/navigation-bar.d.ts +1 -1
- package/@types/ui2/{views → barcode/views}/styled-text.d.ts +2 -1
- package/@types/ui2/configuration/DocumentQualityAnalyzerTypes.d.ts +1 -0
- package/@types/ui2/configuration/DocumentScannerTypes.d.ts +1 -0
- package/@types/ui2/configuration/Geometry.d.ts +1 -1
- package/@types/ui2/configuration/ParametricFilters.d.ts +1 -0
- package/@types/ui2/configuration/{ActionBarConfiguration.d.ts → barcode/ActionBarConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/{ArTrackingOverlayConfiguration.d.ts → barcode/ArTrackingOverlayConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/{BarcodeInfoMapping.d.ts → barcode/BarcodeInfoMapping.d.ts} +1 -1
- package/@types/ui2/configuration/{BarcodeRecognizerConfiguration.d.ts → barcode/BarcodeRecognizerConfiguration.d.ts} +3 -3
- package/@types/ui2/configuration/{BarcodeScannerConfiguration.d.ts → barcode/BarcodeScannerConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/barcode/BarcodeScannerTypes.d.ts +2 -0
- package/@types/ui2/configuration/{BarcodeScannerUIResult.d.ts → barcode/BarcodeScannerUIResult.d.ts} +1 -1
- package/@types/ui2/configuration/{BarcodeTextLocalization.d.ts → barcode/BarcodeTextLocalization.d.ts} +1 -1
- package/@types/ui2/configuration/barcode/BarcodeTypes.d.ts +1 -0
- package/@types/ui2/configuration/{CameraConfiguration.d.ts → barcode/CameraConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/{CameraPermission.d.ts → barcode/CameraPermission.d.ts} +1 -1
- package/@types/ui2/configuration/{Common.d.ts → barcode/Common.d.ts} +1 -1
- package/@types/ui2/configuration/barcode/CommonFieldType.d.ts +1 -0
- package/@types/ui2/configuration/{FindAndPickScanningModeUseCase.d.ts → barcode/FindAndPickScanningModeUseCase.d.ts} +1 -1
- package/@types/ui2/configuration/barcode/GenericDocument.d.ts +1 -0
- package/@types/ui2/configuration/barcode/Geometry.d.ts +1 -0
- package/@types/ui2/configuration/{MultipleScanningModeUseCase.d.ts → barcode/MultipleScanningModeUseCase.d.ts} +1 -1
- package/@types/ui2/configuration/{ScanbotAlertDialog.d.ts → barcode/ScanbotAlertDialog.d.ts} +1 -1
- package/@types/ui2/configuration/{SingleScanningModeUseCase.d.ts → barcode/SingleScanningModeUseCase.d.ts} +1 -1
- package/@types/ui2/configuration/{TopBarConfiguration.d.ts → barcode/TopBarConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/{UserGuidanceConfiguration.d.ts → barcode/UserGuidanceConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/{ViewFinderConfiguration.d.ts → barcode/ViewFinderConfiguration.d.ts} +1 -1
- package/@types/ui2/configuration/common/ActionBarConfiguration.d.ts +42 -0
- package/@types/ui2/configuration/common/CameraConfiguration.d.ts +60 -0
- package/@types/ui2/configuration/common/CameraPermission.d.ts +62 -0
- package/@types/ui2/configuration/common/Common.d.ts +467 -0
- package/@types/ui2/configuration/common/NavigationBarConfiguration.d.ts +11 -0
- package/@types/ui2/configuration/common/ScanbotAlertDialog.d.ts +74 -0
- package/@types/ui2/configuration/common/TopBarConfiguration.d.ts +55 -0
- package/@types/ui2/configuration/common/UserGuidanceConfiguration.d.ts +64 -0
- package/@types/ui2/configuration/common/ViewFinderConfiguration.d.ts +93 -0
- package/@types/ui2/configuration/document/AcknowledgementScreenConfiguration.d.ts +125 -0
- package/@types/ui2/configuration/document/CameraScreenConfiguration.d.ts +659 -0
- package/@types/ui2/configuration/document/CroppingConfiguration.d.ts +1 -0
- package/@types/ui2/configuration/document/CroppingResult.d.ts +1 -0
- package/@types/ui2/configuration/document/CroppingScreenConfiguration.d.ts +141 -0
- package/@types/ui2/configuration/document/CroppingTextLocalization.d.ts +1 -0
- package/@types/ui2/configuration/document/DocumentScannerCameraConfiguration.d.ts +60 -0
- package/@types/ui2/configuration/document/DocumentScannerGuidanceVisibility.d.ts +11 -0
- package/@types/ui2/configuration/document/DocumentScannerOutputSettings.d.ts +38 -0
- package/@types/ui2/configuration/document/DocumentScannerScreens.d.ts +26 -0
- package/@types/ui2/configuration/document/DocumentScannerTextLocalization.d.ts +608 -0
- package/@types/ui2/configuration/document/DocumentScannerUIResult.d.ts +5 -0
- package/@types/ui2/configuration/document/DocumentScannerUserGuidance.d.ts +99 -0
- package/@types/ui2/configuration/document/DocumentScanningFlow.d.ts +91 -0
- package/@types/ui2/configuration/document/IntroductionScreenConfiguration.d.ts +188 -0
- package/@types/ui2/configuration/document/ReorderPagesScreenConfiguration.d.ts +1 -0
- package/@types/ui2/configuration/document/ReviewScreenConfiguration.d.ts +372 -0
- package/@types/ui2/configuration/native/DocumentData.d.ts +37 -0
- package/@types/ui2/configuration/native/PageData.d.ts +58 -0
- package/@types/ui2/configuration/native/PageImageSource.d.ts +13 -0
- package/@types/ui2/configuration/utils.d.ts +8 -0
- package/@types/ui2/configuration.d.ts +46 -21
- package/@types/ui2/document/assets/auto-capture-disabled-icon.d.ts +4 -0
- package/@types/ui2/document/assets/auto-capture-icon.d.ts +4 -0
- package/@types/ui2/document/assets/captured-circle-icon.d.ts +5 -0
- package/@types/ui2/document/assets/delete-icon.d.ts +4 -0
- package/@types/ui2/document/assets/file-add-icon.d.ts +4 -0
- package/@types/ui2/document/assets/image-error-icon.d.ts +5 -0
- package/@types/ui2/document/assets/image-retake.d.ts +4 -0
- package/@types/ui2/document/assets/loading-spinner-icon.d.ts +2 -0
- package/@types/ui2/document/assets/shutter-button-auto-icon.d.ts +4 -0
- package/@types/ui2/document/assets/shutter-button-manual-icon.d.ts +5 -0
- package/@types/ui2/document/assets/shutter-button-spinner-icon.d.ts +4 -0
- package/@types/ui2/document/assets/the-hand.d.ts +10 -0
- package/@types/ui2/document/controller/acknowledgment-screen-controller.d.ts +16 -0
- package/@types/ui2/document/controller/camera-screen-controller.d.ts +20 -0
- package/@types/ui2/document/controller/cropping-screen-controller.d.ts +14 -0
- package/@types/ui2/document/controller/document-scanner-controller.d.ts +14 -0
- package/@types/ui2/document/controller/review-screen-controller.d.ts +18 -0
- package/@types/ui2/document/controller/zoom-screen-controller.d.ts +11 -0
- package/@types/ui2/document/model/document-detection-ui-result.d.ts +8 -0
- package/@types/ui2/document/model/sb-document.d.ts +62 -0
- package/@types/ui2/document/model/sb-page.d.ts +38 -0
- package/@types/ui2/document/model/utils/sb-document-data.d.ts +10 -0
- package/@types/ui2/document/model/utils/sb-page-data.d.ts +7 -0
- package/@types/ui2/document/utils/SBThemeProvider.d.ts +4 -0
- package/@types/ui2/document/utils/button-accessibility-styling.d.ts +40 -0
- package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-confirmation.d.ts +19 -0
- package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-fade.d.ts +9 -0
- package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-image.d.ts +6 -0
- package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-screen-bottom-bar.d.ts +12 -0
- package/@types/ui2/document/views/acknowledgement-screen/quality-insufficient-banner.d.ts +10 -0
- package/@types/ui2/document/views/camera-screen/bottom-bar.d.ts +33 -0
- package/@types/ui2/document/views/camera-screen/camera-permission-denied.d.ts +9 -0
- package/@types/ui2/document/views/camera-screen/camera-select-dropdown.d.ts +14 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/CheckIcon.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/CreditCardsIcon.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/DocumentsIcon.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/IdCardsIcon.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/MedicalCertsIcon.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/Props.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/assets/ReceiptsIcon.d.ts +3 -0
- package/@types/ui2/document/views/camera-screen/introduction/introduction-image.d.ts +5 -0
- package/@types/ui2/document/views/camera-screen/introduction/introduction.d.ts +9 -0
- package/@types/ui2/document/views/camera-screen/preview-button.d.ts +11 -0
- package/@types/ui2/document/views/camera-screen/scanner-box.d.ts +21 -0
- package/@types/ui2/document/views/camera-screen/shutter-button.d.ts +10 -0
- package/@types/ui2/document/views/camera-screen/top-bar.d.ts +11 -0
- package/@types/ui2/document/views/camera-screen/top-user-guidance.d.ts +8 -0
- package/@types/ui2/document/views/camera-screen/use-document-scanner-view.d.ts +31 -0
- package/@types/ui2/document/views/camera-screen/user-guidance-text.d.ts +10 -0
- package/@types/ui2/document/views/common/alert-dialog.d.ts +11 -0
- package/@types/ui2/document/views/common/bar-button.d.ts +17 -0
- package/@types/ui2/document/views/common/common-top-bar.d.ts +12 -0
- package/@types/ui2/document/views/common/loading-spinner.d.ts +4 -0
- package/@types/ui2/document/views/common/styled-menu-item.d.ts +12 -0
- package/@types/ui2/document/views/common/styled-menu.d.ts +17 -0
- package/@types/ui2/document/views/review-screen/bottom-bar.d.ts +15 -0
- package/@types/ui2/document/views/review-screen/carousel-page.d.ts +13 -0
- package/@types/ui2/document/views/review-screen/carousel.d.ts +14 -0
- package/@types/ui2/document/views/review-screen/page-counter-and-zoom-button.d.ts +10 -0
- package/@types/ui2/document/views/review-screen/scroller-navigation-button.d.ts +11 -0
- package/@types/ui2/document/views/review-screen/top-bar.d.ts +11 -0
- package/@types/ui2/scanbot-sdk-ui.d.ts +4 -0
- package/@types/ui2/scanbot-ui-library.d.ts +7 -4
- package/@types/ui2/utils/text-styling.d.ts +8 -0
- package/@types/ui2/utils/use-time-since-first-render-has-passed.d.ts +1 -0
- package/@types/utils/constants.d.ts +0 -2
- package/@types/utils/dto/Frame.d.ts +2 -0
- package/@types/utils/image-utils.d.ts +2 -1
- package/@types/utils/parse-color.d.ts +9 -0
- package/@types/utils/react/useIsMounted.d.ts +2 -0
- package/@types/utils/react/usePromise.d.ts +4 -3
- package/@types/utils/supported-image-mime-types.d.ts +2 -0
- package/@types/utils/view-utils.d.ts +1 -1
- package/@types/view/barcode-polygon/animated-barcode-selection-overlay.d.ts +8 -2
- package/@types/view/polygon/document-polygon.d.ts +1 -0
- package/@types/worker/worker-bridge.d.ts +522 -384
- package/Libraries.txt +1510 -36
- package/bundle/ScanbotSDK.min.js +5 -5
- package/bundle/ScanbotSDK.ui2.min.js +18 -18
- package/bundle/ScanbotSDK.ui2.min.js.LICENSE.txt +10 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
- package/package.json +3 -3
- package/@types/core/bridge/compiled/CheckRecognizerTypes.d.ts +0 -29
- package/@types/core/bridge/compiled/FrameUtilities.d.ts +0 -18
- package/@types/core/bridge/compiled/GDRTypes.d.ts +0 -38
- package/@types/core/bridge/compiled/GenericDocumentRecognizerConfigs.d.ts +0 -150
- package/@types/core/bridge/compiled/GenericDocumentRecognizerTypes.d.ts +0 -83
- package/@types/core/bridge/compiled/GenericDocumentTypes.d.ts +0 -15
- package/@types/core/bridge/compiled/MRZTypes.d.ts +0 -52
- package/@types/generic-document-recognizer-view.d.ts +0 -22
- package/@types/interfaces/i-generic-document-recognizer-scanner-handle.d.ts +0 -3
- package/@types/model/configuration/generic-document-recognizer-configuration.d.ts +0 -9
- package/@types/model/configuration/text-data-scanner-configuration.d.ts +0 -9
- package/@types/service/generic-document-recognizer.d.ts +0 -13
- package/@types/service/text-data-recognizer.d.ts +0 -14
- package/@types/ui2/configuration/BarcodeScannerTypes.d.ts +0 -1
- package/@types/ui2/configuration/BarcodeTypes.d.ts +0 -1
- package/@types/ui2/configuration/CommonFieldType.d.ts +0 -1
- package/@types/ui2/configuration/GenericDocument.d.ts +0 -1
- package/@types/ui2/utils/styled-button.d.ts +0 -7
- /package/@types/core/bridge/compiled/{OcrElements.d.ts → OcrTypes.d.ts} +0 -0
- /package/@types/ui2/{utils → barcode/utils}/find-and-pick.ts/expected-barcode-counter.d.ts +0 -0
- /package/@types/ui2/{utils → barcode/utils}/styled-input.d.ts +0 -0
- /package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-drawer-header.d.ts +0 -0
- /package/@types/ui2/configuration/{BarcodeItemMapper.d.ts → barcode/BarcodeItemMapper.d.ts} +0 -0
- /package/@types/ui2/configuration/{BarcodeUseCase.d.ts → barcode/BarcodeUseCase.d.ts} +0 -0
package/@types/scanbot-sdk.d.ts
CHANGED
|
@@ -15,18 +15,19 @@ import { MrzScannerConfiguration } from "./model/configuration/mrz-scanner-confi
|
|
|
15
15
|
import { IMrzScannerHandle } from "./interfaces/i-mrz-scanner-handle";
|
|
16
16
|
import SimpleMrzRecognizer from "./service/simple-mrz-recognizer";
|
|
17
17
|
import OcrEngine from "./service/ocr-engine";
|
|
18
|
-
import {
|
|
18
|
+
import { TextPatternScannerConfiguration } from "./model/configuration/text-pattern-scanner-configuration";
|
|
19
19
|
import { VINScannerConfiguration } from "./model/configuration/vin-scanner-configuration";
|
|
20
|
-
import {
|
|
20
|
+
import { ITextPatternScannerHandle } from "./interfaces/i-text-pattern-scanner-handle";
|
|
21
21
|
import DocumentQualityAnalyzer from "./service/document-quality-analyzer";
|
|
22
22
|
import ScanbotSDKUI from "./ui2/scanbot-sdk-ui";
|
|
23
|
-
import { Image, DeepPartial, RawImage, ObjectId, Point,
|
|
23
|
+
import { Image, DeepPartial, RawImage, ObjectId, Point, TextPatternScannerTypes, VinScannerTypes, TiffTypes, PdfConfigurationTypes, ParametricFilters, ImageTypes, DocumentQualityAnalyzerTypes, MrzTypes, BarcodeScannerTypes, BarcodeDocumentTypes, CroppedDetectionResult, DocumentScannerTypes, DocumentDataExtractorTypes } from "./core-types";
|
|
24
24
|
import * as Config from "./core-types";
|
|
25
|
-
import
|
|
26
|
-
import {
|
|
25
|
+
import { DocumentDataExtractor } from "./service/document-data-extractor";
|
|
26
|
+
import { DocumentDataExtractorConfiguration } from "./model/configuration/document-data-extractor-configuration";
|
|
27
27
|
import { ConsumeType } from "./consume-type";
|
|
28
28
|
import { Stats } from "./utils/stats";
|
|
29
29
|
import { BrowserCameras } from "./utils/browser-cameras";
|
|
30
|
+
import { SBStorage } from "./service/storage/sb-storage";
|
|
30
31
|
export default class ScanbotSDK {
|
|
31
32
|
/** @internal */
|
|
32
33
|
bridge: WorkerBridge;
|
|
@@ -37,6 +38,7 @@ export default class ScanbotSDK {
|
|
|
37
38
|
private static _ui2;
|
|
38
39
|
static get UI(): typeof ScanbotSDKUI;
|
|
39
40
|
static initialize(options: InitializationOptions): Promise<ScanbotSDK>;
|
|
41
|
+
storage: SBStorage;
|
|
40
42
|
/**
|
|
41
43
|
* View Components
|
|
42
44
|
*/
|
|
@@ -44,19 +46,19 @@ export default class ScanbotSDK {
|
|
|
44
46
|
createMrzScanner(configuration: MrzScannerConfiguration): Promise<IMrzScannerHandle>;
|
|
45
47
|
createBarcodeScanner(configuration: BarcodeScannerConfiguration): Promise<IBarcodeScannerHandle>;
|
|
46
48
|
openCroppingView(configuration: CroppingViewConfiguration): Promise<ICroppingViewHandle>;
|
|
47
|
-
|
|
48
|
-
createVINScanner(configuration: VINScannerConfiguration): Promise<
|
|
49
|
-
|
|
49
|
+
createTextPatternScanner(configuration: TextPatternScannerConfiguration): Promise<ITextPatternScannerHandle>;
|
|
50
|
+
createVINScanner(configuration: VINScannerConfiguration): Promise<ITextPatternScannerHandle>;
|
|
51
|
+
createDocumentDataExtractorScanner(config: DocumentDataExtractorConfiguration): Promise<any>;
|
|
50
52
|
/**
|
|
51
53
|
* Image Operations
|
|
52
54
|
*/
|
|
53
55
|
toDataUrl(imageBuffer: ArrayBuffer): Promise<string>;
|
|
54
|
-
/** @param detectionParameters {@displayType `DeepPartial<
|
|
55
|
-
detectDocument(
|
|
56
|
+
/** @param detectionParameters {@displayType `DeepPartial<DocumentScannerTypes.DocumentScannerParameters>`} {@link DocumentScannerTypes.DocumentScannerParameters}*/
|
|
57
|
+
detectDocument(image: Image, detectionParameters?: DeepPartial<DocumentScannerTypes.DocumentScannerParameters>, consumeImage?: ConsumeType): Promise<DocumentScannerTypes.DocumentDetectionResult>;
|
|
56
58
|
detectAndCropDocument(imageBuffer: Image, consumeImage?: ConsumeType): Promise<CroppedDetectionResult>;
|
|
57
59
|
/**
|
|
58
60
|
* @param image An image URL (e.g. Data URL or HTTP URL) or an Image object
|
|
59
|
-
* @param detectionParameters {@displayType `Omit<DeepPartial<BarcodeScannerTypes.
|
|
61
|
+
* @param detectionParameters {@displayType `Omit<DeepPartial<BarcodeScannerTypes.BarcodeScannerConfiguration>, "live">`} {@link BarcodeScannerTypes.BarcodeScannerConfiguration}
|
|
60
62
|
* */
|
|
61
63
|
detectBarcodes(image: string | Image, partialDetectionParameters?: DeepPartial<Omit<BarcodeScannerTypes.BarcodeScannerConfiguration, "live">>, consumeImage?: ConsumeType): Promise<BarcodeScannerTypes.BarcodeScannerResult & {
|
|
62
64
|
originalImage: Image;
|
|
@@ -75,12 +77,12 @@ export default class ScanbotSDK {
|
|
|
75
77
|
* Misc. Features
|
|
76
78
|
*/
|
|
77
79
|
getLicenseInfo(): Promise<LicenseInfo>;
|
|
78
|
-
/** @param options {@displayType `DeepPartial<
|
|
79
|
-
beginPdf(options: DeepPartial<
|
|
80
|
-
/** @param options {@displayType `DeepPartial<TiffTypes.
|
|
81
|
-
beginTiff(options?: DeepPartial<TiffTypes.
|
|
82
|
-
/** @param options {@displayType `DeepPartial<
|
|
83
|
-
|
|
80
|
+
/** @param options {@displayType `DeepPartial<PdfConfigurationTypes.PdfConfiguration>`} {@link PdfConfigurationTypes.PdfConfiguration}*/
|
|
81
|
+
beginPdf(options: DeepPartial<PdfConfigurationTypes.PdfConfiguration>): Promise<PdfGenerator>;
|
|
82
|
+
/** @param options {@displayType `DeepPartial<TiffTypes.TiffWriterParameters>`} {@link TiffTypes.TiffWriterParameters} */
|
|
83
|
+
beginTiff(options?: DeepPartial<TiffTypes.TiffWriterParameters>): Promise<TiffGenerator>;
|
|
84
|
+
/** @param options {@displayType `DeepPartial<DocumentDataExtractorTypes.DocumentDataExtractorConfiguration>`} {@link DocumentDataExtractorTypes.DocumentDataExtractorConfiguration}*/
|
|
85
|
+
createDocumentDataExtractor(options: DeepPartial<DocumentDataExtractorTypes.DocumentDataExtractorConfiguration>): Promise<DocumentDataExtractor>;
|
|
84
86
|
imageToJpeg(image: Image, consumeImage?: ConsumeType): Promise<Uint8Array>;
|
|
85
87
|
get version(): string;
|
|
86
88
|
private _utils;
|
|
@@ -109,9 +111,9 @@ export default class ScanbotSDK {
|
|
|
109
111
|
}[];
|
|
110
112
|
ignoreOrientationMismatch?: boolean;
|
|
111
113
|
_marker?: () => void;
|
|
112
|
-
}) => Promise<
|
|
114
|
+
}) => Promise<DocumentScannerTypes.DocumentDetectionResult>;
|
|
113
115
|
detectAndCropDocument: (image: Image) => Promise<CroppedDetectionResult>;
|
|
114
|
-
|
|
116
|
+
createDocumentScanner: (options: {
|
|
115
117
|
isLive?: boolean;
|
|
116
118
|
acceptedAngleScore?: number;
|
|
117
119
|
acceptedSizeScore?: number;
|
|
@@ -124,256 +126,313 @@ export default class ScanbotSDK {
|
|
|
124
126
|
}[];
|
|
125
127
|
ignoreOrientationMismatch?: boolean;
|
|
126
128
|
_marker?: () => void;
|
|
127
|
-
}) => Promise<ObjectId<"
|
|
128
|
-
|
|
129
|
+
}) => Promise<ObjectId<"DocumentScanner">>;
|
|
130
|
+
documentScannerDetect: <ImageType extends Image>(documentScannerToken: ObjectId<"DocumentScanner">, image: ImageType) => Promise<DocumentScannerTypes.DocumentDetectionResult & {
|
|
129
131
|
originalImage: ImageType;
|
|
130
132
|
}>;
|
|
131
133
|
parseBarcodeDocument: (options: BarcodeDocumentTypes.BarcodeDocumentFormat[], data: string) => Promise<Config.GenericDocument.GenericDocument>;
|
|
132
|
-
|
|
134
|
+
createBarcodeScanner: (options: {
|
|
133
135
|
barcodeFormatConfigurations?: ({
|
|
134
136
|
readonly _type?: "BarcodeFormatCodabarConfiguration";
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
137
|
+
regexFilter?: string;
|
|
138
|
+
minimumSizeScore?: number;
|
|
139
|
+
addAdditionalQuietZone?: boolean;
|
|
140
|
+
minimum1DQuietZoneSize?: number;
|
|
141
|
+
minimumTextLength?: number;
|
|
142
|
+
maximumTextLength?: number;
|
|
143
|
+
returnStartEnd?: boolean;
|
|
140
144
|
_marker?: () => void;
|
|
141
145
|
} | {
|
|
142
146
|
readonly _type?: "BarcodeFormatCode11Configuration";
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
147
|
+
regexFilter?: string;
|
|
148
|
+
minimumSizeScore?: number;
|
|
149
|
+
addAdditionalQuietZone?: boolean;
|
|
150
|
+
minimum1DQuietZoneSize?: number;
|
|
151
|
+
stripCheckDigits?: boolean;
|
|
152
|
+
minimumTextLength?: number;
|
|
153
|
+
maximumTextLength?: number;
|
|
154
|
+
checksum?: boolean;
|
|
149
155
|
_marker?: () => void;
|
|
150
156
|
} | {
|
|
151
157
|
readonly _type?: "BarcodeFormatCode39Configuration";
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
158
|
+
regexFilter?: string;
|
|
159
|
+
minimumSizeScore?: number;
|
|
160
|
+
addAdditionalQuietZone?: boolean;
|
|
161
|
+
minimum1DQuietZoneSize?: number;
|
|
162
|
+
stripCheckDigits?: boolean;
|
|
163
|
+
minimumTextLength?: number;
|
|
164
|
+
maximumTextLength?: number;
|
|
165
|
+
code32?: boolean;
|
|
166
|
+
code39?: boolean;
|
|
167
|
+
pzn?: boolean;
|
|
168
|
+
tryCode39ExtendedMode?: boolean;
|
|
169
|
+
useCode39CheckDigit?: boolean;
|
|
162
170
|
_marker?: () => void;
|
|
163
171
|
} | {
|
|
164
172
|
readonly _type?: "BarcodeFormatCode93Configuration";
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
173
|
+
regexFilter?: string;
|
|
174
|
+
minimumSizeScore?: number;
|
|
175
|
+
addAdditionalQuietZone?: boolean;
|
|
176
|
+
minimum1DQuietZoneSize?: number;
|
|
177
|
+
minimumTextLength?: number;
|
|
178
|
+
maximumTextLength?: number;
|
|
169
179
|
_marker?: () => void;
|
|
170
180
|
} | {
|
|
171
181
|
readonly _type?: "BarcodeFormatCode128Configuration";
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
182
|
+
regexFilter?: string;
|
|
183
|
+
minimumSizeScore?: number;
|
|
184
|
+
addAdditionalQuietZone?: boolean;
|
|
185
|
+
minimum1DQuietZoneSize?: number;
|
|
186
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
187
|
+
minimumTextLength?: number;
|
|
188
|
+
maximumTextLength?: number;
|
|
177
189
|
_marker?: () => void;
|
|
178
190
|
} | {
|
|
179
191
|
readonly _type?: "BarcodeFormatCode2Of5Configuration";
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
192
|
+
regexFilter?: string;
|
|
193
|
+
minimumSizeScore?: number;
|
|
194
|
+
addAdditionalQuietZone?: boolean;
|
|
195
|
+
minimum1DQuietZoneSize?: number;
|
|
196
|
+
stripCheckDigits?: boolean;
|
|
197
|
+
minimumTextLength?: number;
|
|
198
|
+
maximumTextLength?: number;
|
|
199
|
+
iata2of5?: boolean;
|
|
200
|
+
code25?: boolean;
|
|
201
|
+
industrial2of5?: boolean;
|
|
202
|
+
useIATA2OF5Checksum?: boolean;
|
|
189
203
|
_marker?: () => void;
|
|
190
204
|
} | {
|
|
191
205
|
readonly _type?: "BarcodeFormatDataBarConfiguration";
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
206
|
+
regexFilter?: string;
|
|
207
|
+
minimumSizeScore?: number;
|
|
208
|
+
addAdditionalQuietZone?: boolean;
|
|
209
|
+
minimum1DQuietZoneSize?: number;
|
|
210
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
195
211
|
_marker?: () => void;
|
|
196
212
|
} | {
|
|
197
213
|
readonly _type?: "BarcodeFormatDataBarExpandedConfiguration";
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
214
|
+
regexFilter?: string;
|
|
215
|
+
minimumSizeScore?: number;
|
|
216
|
+
addAdditionalQuietZone?: boolean;
|
|
217
|
+
minimum1DQuietZoneSize?: number;
|
|
218
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
201
219
|
_marker?: () => void;
|
|
202
220
|
} | {
|
|
203
221
|
readonly _type?: "BarcodeFormatDataBarLimitedConfiguration";
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
222
|
+
regexFilter?: string;
|
|
223
|
+
minimumSizeScore?: number;
|
|
224
|
+
addAdditionalQuietZone?: boolean;
|
|
225
|
+
minimum1DQuietZoneSize?: number;
|
|
226
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
207
227
|
_marker?: () => void;
|
|
208
228
|
} | {
|
|
209
229
|
readonly _type?: "BarcodeFormatITFConfiguration";
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
230
|
+
regexFilter?: string;
|
|
231
|
+
minimumSizeScore?: number;
|
|
232
|
+
addAdditionalQuietZone?: boolean;
|
|
233
|
+
minimum1DQuietZoneSize?: number;
|
|
234
|
+
minimumTextLength?: number;
|
|
235
|
+
maximumTextLength?: number;
|
|
214
236
|
_marker?: () => void;
|
|
215
237
|
} | {
|
|
216
238
|
readonly _type?: "BarcodeFormatMSIPlesseyConfiguration";
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
239
|
+
regexFilter?: string;
|
|
240
|
+
minimumSizeScore?: number;
|
|
241
|
+
addAdditionalQuietZone?: boolean;
|
|
242
|
+
minimum1DQuietZoneSize?: number;
|
|
243
|
+
stripCheckDigits?: boolean;
|
|
244
|
+
minimumTextLength?: number;
|
|
245
|
+
maximumTextLength?: number;
|
|
246
|
+
checksumAlgorithms?: Config.BarcodeConfigurationTypes.MsiPlesseyChecksumAlgorithm[];
|
|
223
247
|
_marker?: () => void;
|
|
224
248
|
} | {
|
|
225
249
|
readonly _type?: "BarcodeFormatUpcEanConfiguration";
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
250
|
+
regexFilter?: string;
|
|
251
|
+
minimumSizeScore?: number;
|
|
252
|
+
addAdditionalQuietZone?: boolean;
|
|
253
|
+
minimum1DQuietZoneSize?: number;
|
|
254
|
+
stripCheckDigits?: boolean;
|
|
255
|
+
ean8?: boolean;
|
|
256
|
+
ean13?: boolean;
|
|
257
|
+
upca?: boolean;
|
|
258
|
+
upce?: boolean;
|
|
259
|
+
extensions?: Config.BarcodeTypes.UpcEanExtensionBehavior;
|
|
234
260
|
_marker?: () => void;
|
|
235
261
|
} | {
|
|
236
262
|
readonly _type?: "BarcodeFormatPharmaCodeConfiguration";
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
263
|
+
regexFilter?: string;
|
|
264
|
+
minimumSizeScore?: number;
|
|
265
|
+
addAdditionalQuietZone?: boolean;
|
|
266
|
+
minimum1DQuietZoneSize?: number;
|
|
267
|
+
minimumValue?: number;
|
|
268
|
+
allowNarrowBarsOnly?: boolean;
|
|
269
|
+
allowWideBarsOnly?: boolean;
|
|
242
270
|
_marker?: () => void;
|
|
243
271
|
} | {
|
|
244
272
|
readonly _type?: "BarcodeFormatAztecConfiguration";
|
|
245
|
-
|
|
246
|
-
|
|
273
|
+
regexFilter?: string;
|
|
274
|
+
minimumSizeScore?: number;
|
|
275
|
+
addAdditionalQuietZone?: boolean;
|
|
276
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
247
277
|
_marker?: () => void;
|
|
248
278
|
} | {
|
|
249
279
|
readonly _type?: "BarcodeFormatQRCodeConfiguration";
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
280
|
+
regexFilter?: string;
|
|
281
|
+
minimumSizeScore?: number;
|
|
282
|
+
addAdditionalQuietZone?: boolean;
|
|
283
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
284
|
+
strictMode?: boolean;
|
|
285
|
+
qr?: boolean;
|
|
286
|
+
microQr?: boolean;
|
|
287
|
+
rmqr?: boolean;
|
|
256
288
|
_marker?: () => void;
|
|
257
289
|
} | {
|
|
258
290
|
readonly _type?: "BarcodeFormatPDF417Configuration";
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
291
|
+
regexFilter?: string;
|
|
292
|
+
minimumSizeScore?: number;
|
|
293
|
+
addAdditionalQuietZone?: boolean;
|
|
294
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
295
|
+
strictMode?: boolean;
|
|
262
296
|
_marker?: () => void;
|
|
263
297
|
} | {
|
|
264
298
|
readonly _type?: "BarcodeFormatMicroPDF417Configuration";
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
299
|
+
regexFilter?: string;
|
|
300
|
+
minimumSizeScore?: number;
|
|
301
|
+
addAdditionalQuietZone?: boolean;
|
|
302
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
303
|
+
strictMode?: boolean;
|
|
268
304
|
_marker?: () => void;
|
|
269
305
|
} | {
|
|
270
306
|
readonly _type?: "BarcodeFormatDataMatrixConfiguration";
|
|
271
|
-
|
|
272
|
-
|
|
307
|
+
regexFilter?: string;
|
|
308
|
+
minimumSizeScore?: number;
|
|
309
|
+
addAdditionalQuietZone?: boolean;
|
|
310
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
273
311
|
_marker?: () => void;
|
|
274
312
|
} | {
|
|
275
313
|
readonly _type?: "BarcodeFormatMaxiCodeConfiguration";
|
|
276
|
-
|
|
314
|
+
regexFilter?: string;
|
|
315
|
+
minimumSizeScore?: number;
|
|
316
|
+
addAdditionalQuietZone?: boolean;
|
|
277
317
|
_marker?: () => void;
|
|
278
318
|
} | {
|
|
279
319
|
readonly _type?: "BarcodeFormatAustraliaPostConfiguration";
|
|
280
|
-
|
|
281
|
-
|
|
320
|
+
regexFilter?: string;
|
|
321
|
+
minimumSizeScore?: number;
|
|
322
|
+
addAdditionalQuietZone?: boolean;
|
|
323
|
+
australiaPostCustomerFormat?: Config.BarcodeConfigurationTypes.AustraliaPostCustomerFormat;
|
|
282
324
|
_marker?: () => void;
|
|
283
325
|
} | {
|
|
284
326
|
readonly _type?: "BarcodeFormatJapanPostConfiguration";
|
|
285
|
-
|
|
327
|
+
regexFilter?: string;
|
|
328
|
+
minimumSizeScore?: number;
|
|
329
|
+
addAdditionalQuietZone?: boolean;
|
|
286
330
|
_marker?: () => void;
|
|
287
331
|
} | {
|
|
288
332
|
readonly _type?: "BarcodeFormatRoyalMailConfiguration";
|
|
289
|
-
|
|
290
|
-
|
|
333
|
+
regexFilter?: string;
|
|
334
|
+
minimumSizeScore?: number;
|
|
335
|
+
addAdditionalQuietZone?: boolean;
|
|
336
|
+
stripCheckDigits?: boolean;
|
|
291
337
|
_marker?: () => void;
|
|
292
338
|
} | {
|
|
293
339
|
readonly _type?: "BarcodeFormatRoyalTNTPostConfiguration";
|
|
294
|
-
|
|
340
|
+
regexFilter?: string;
|
|
341
|
+
minimumSizeScore?: number;
|
|
342
|
+
addAdditionalQuietZone?: boolean;
|
|
295
343
|
_marker?: () => void;
|
|
296
344
|
} | {
|
|
297
345
|
readonly _type?: "BarcodeFormatUSPSIntelligentMailConfiguration";
|
|
298
|
-
|
|
346
|
+
regexFilter?: string;
|
|
347
|
+
minimumSizeScore?: number;
|
|
348
|
+
addAdditionalQuietZone?: boolean;
|
|
299
349
|
_marker?: () => void;
|
|
300
350
|
} | {
|
|
301
351
|
readonly _type?: "BarcodeFormatPharmaCodeTwoTrackConfiguration";
|
|
302
|
-
|
|
303
|
-
|
|
352
|
+
regexFilter?: string;
|
|
353
|
+
minimumSizeScore?: number;
|
|
354
|
+
addAdditionalQuietZone?: boolean;
|
|
355
|
+
minimumValue?: number;
|
|
304
356
|
_marker?: () => void;
|
|
305
357
|
} | {
|
|
306
358
|
readonly _type?: "BarcodeFormatGS1CompositeConfiguration";
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
359
|
+
regexFilter?: string;
|
|
360
|
+
minimumSizeScore?: number;
|
|
361
|
+
addAdditionalQuietZone?: boolean;
|
|
362
|
+
minimum1DQuietZoneSize?: number;
|
|
363
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
364
|
+
strictMode?: boolean;
|
|
311
365
|
_marker?: () => void;
|
|
312
366
|
} | {
|
|
313
367
|
readonly _type?: "BarcodeFormatCommonOneDConfiguration";
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
368
|
+
regexFilter?: string;
|
|
369
|
+
minimumSizeScore?: number;
|
|
370
|
+
addAdditionalQuietZone?: boolean;
|
|
371
|
+
minimum1DQuietZoneSize?: number;
|
|
372
|
+
stripCheckDigits?: boolean;
|
|
373
|
+
minimumTextLength?: number;
|
|
374
|
+
maximumTextLength?: number;
|
|
375
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
376
|
+
strictMode?: boolean;
|
|
377
|
+
formats?: Config.BarcodeTypes.BarcodeFormat[];
|
|
322
378
|
_marker?: () => void;
|
|
323
379
|
} | {
|
|
324
380
|
readonly _type?: "BarcodeFormatCommonTwoDConfiguration";
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
381
|
+
regexFilter?: string;
|
|
382
|
+
minimumSizeScore?: number;
|
|
383
|
+
addAdditionalQuietZone?: boolean;
|
|
384
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
385
|
+
strictMode?: boolean;
|
|
386
|
+
formats?: Config.BarcodeTypes.BarcodeFormat[];
|
|
329
387
|
_marker?: () => void;
|
|
330
388
|
} | {
|
|
331
389
|
readonly _type?: "BarcodeFormatCommonFourStateConfiguration";
|
|
332
|
-
|
|
333
|
-
|
|
390
|
+
regexFilter?: string;
|
|
391
|
+
minimumSizeScore?: number;
|
|
392
|
+
addAdditionalQuietZone?: boolean;
|
|
393
|
+
formats?: Config.BarcodeTypes.BarcodeFormat[];
|
|
334
394
|
_marker?: () => void;
|
|
335
395
|
} | {
|
|
336
396
|
readonly _type?: "BarcodeFormatCommonConfiguration";
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
397
|
+
regexFilter?: string;
|
|
398
|
+
minimumSizeScore?: number;
|
|
399
|
+
addAdditionalQuietZone?: boolean;
|
|
400
|
+
minimum1DQuietZoneSize?: number;
|
|
401
|
+
stripCheckDigits?: boolean;
|
|
402
|
+
minimumTextLength?: number;
|
|
403
|
+
maximumTextLength?: number;
|
|
404
|
+
gs1Handling?: Config.BarcodeTypes.Gs1Handling;
|
|
405
|
+
strictMode?: boolean;
|
|
406
|
+
formats?: Config.BarcodeTypes.BarcodeFormat[];
|
|
345
407
|
_marker?: () => void;
|
|
346
408
|
})[];
|
|
347
|
-
|
|
409
|
+
extractedDocumentFormats?: BarcodeDocumentTypes.BarcodeDocumentFormat[];
|
|
348
410
|
onlyAcceptDocuments?: boolean;
|
|
349
411
|
returnBarcodeImage?: boolean;
|
|
350
412
|
engineMode?: BarcodeScannerTypes.BarcodeScannerEngineMode;
|
|
351
413
|
live?: boolean;
|
|
352
414
|
_marker?: () => void;
|
|
353
|
-
}) => Promise<ObjectId<"
|
|
354
|
-
|
|
415
|
+
}) => Promise<ObjectId<"BarcodeScanner">>;
|
|
416
|
+
scanBarcodes: <ImageType_1 extends Image>(barcodeScannerToken: ObjectId<"BarcodeScanner">, image: ImageType_1) => Promise<BarcodeScannerTypes.BarcodeScannerResult & {
|
|
355
417
|
originalImage: ImageType_1;
|
|
356
418
|
}>;
|
|
357
419
|
beginPdf: (options: {
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
420
|
+
attributes?: {
|
|
421
|
+
author?: string;
|
|
422
|
+
creator?: string;
|
|
423
|
+
title?: string;
|
|
424
|
+
subject?: string;
|
|
425
|
+
keywords?: string;
|
|
364
426
|
_marker?: () => void;
|
|
365
427
|
};
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
428
|
+
pageSize?: PdfConfigurationTypes.PageSize;
|
|
429
|
+
pageDirection?: PdfConfigurationTypes.PageDirection;
|
|
430
|
+
pageFit?: PdfConfigurationTypes.PageFit;
|
|
431
|
+
dpi?: number;
|
|
432
|
+
jpegQuality?: number;
|
|
433
|
+
resamplingMethod?: PdfConfigurationTypes.ResamplingMethod;
|
|
372
434
|
_marker?: () => void;
|
|
373
|
-
}) => Promise<ObjectId<"PdfGenerationContext">>;
|
|
374
|
-
* @param image An image URL (e.g. Data URL or HTTP URL) or an Image object
|
|
375
|
-
* @param detectionParameters {@displayType `Omit<DeepPartial<BarcodeScannerTypes.BarcodeRecognizerParameters>, "live">`} {@link BarcodeScannerTypes.BarcodeRecognizerParameters}
|
|
376
|
-
* */
|
|
435
|
+
}) => Promise<ObjectId<"PdfGenerationContext">>;
|
|
377
436
|
addPageToPdf: (pdfOperation: ObjectId<"PdfGenerationContext">, image: Image) => Promise<void>;
|
|
378
437
|
completePdf: (pdfOperation: ObjectId<"PdfGenerationContext">) => Promise<Uint8Array>;
|
|
379
438
|
beginTiff: (options: {
|
|
@@ -382,19 +441,19 @@ export default class ScanbotSDK {
|
|
|
382
441
|
zipCompressionLevel?: number;
|
|
383
442
|
dpi?: number;
|
|
384
443
|
userFields?: {
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
444
|
+
tag?: number;
|
|
445
|
+
name?: string;
|
|
446
|
+
value?: {
|
|
388
447
|
readonly _type?: "UserFieldDoubleValue";
|
|
389
|
-
|
|
448
|
+
value?: number;
|
|
390
449
|
_marker?: () => void;
|
|
391
450
|
} | {
|
|
392
451
|
readonly _type?: "UserFieldStringValue";
|
|
393
|
-
|
|
452
|
+
value?: string;
|
|
394
453
|
_marker?: () => void;
|
|
395
454
|
} | {
|
|
396
455
|
readonly _type?: "UserFieldIntValue";
|
|
397
|
-
|
|
456
|
+
value?: number;
|
|
398
457
|
_marker?: () => void;
|
|
399
458
|
};
|
|
400
459
|
_marker?: () => void;
|
|
@@ -441,21 +500,23 @@ export default class ScanbotSDK {
|
|
|
441
500
|
}) => Promise<ObjectId<"TiffGenerationContext">>;
|
|
442
501
|
addPageToTiff: (tiffOperation: ObjectId<"TiffGenerationContext">, image: Image, binarization: TiffTypes.Binarization) => Promise<unknown>;
|
|
443
502
|
completeTiff: (tiffOperation: ObjectId<"TiffGenerationContext">) => Promise<Uint8Array>;
|
|
444
|
-
|
|
445
|
-
|
|
503
|
+
createMRZScanner: (configuration: {
|
|
504
|
+
frameAccumulationConfiguration?: {
|
|
446
505
|
maximumNumberOfAccumulatedFrames?: number;
|
|
447
506
|
minimumNumberOfRequiredFramesWithEqualRecognitionResult?: number;
|
|
448
507
|
_marker?: () => void;
|
|
449
508
|
};
|
|
509
|
+
enableDetection?: boolean;
|
|
510
|
+
incompleteResultHandling?: MrzTypes.MrzIncompleteResultHandling;
|
|
450
511
|
_marker?: () => void;
|
|
451
|
-
}) => Promise<ObjectId<"
|
|
452
|
-
|
|
512
|
+
}) => Promise<ObjectId<"MRZScannerContext">>;
|
|
513
|
+
scanMRZ: <ImageType_2 extends Image>(mrzScannerToken: ObjectId<"MRZScannerContext">, image: ImageType_2) => Promise<MrzTypes.MrzScannerResult & {
|
|
453
514
|
originalImage: ImageType_2;
|
|
454
515
|
}>;
|
|
455
516
|
releaseObject: <T>(objectToken: ObjectId<T>) => Promise<void>;
|
|
456
517
|
createOcrEngine: () => Promise<ObjectId<"TLDROcrContext">>;
|
|
457
|
-
performOcr: (tldrOcrToken: ObjectId<"TLDROcrContext">, image: Image) => Promise<Config.
|
|
458
|
-
|
|
518
|
+
performOcr: (tldrOcrToken: ObjectId<"TLDROcrContext">, image: Image) => Promise<Config.OcrTypes.Page>;
|
|
519
|
+
createTextPatternScanner: (configuration: {
|
|
459
520
|
ocrResolutionLimit?: number;
|
|
460
521
|
maximumNumberOfAccumulatedFrames?: number;
|
|
461
522
|
minimumNumberOfRequiredFramesWithEqualRecognitionResult?: number;
|
|
@@ -463,10 +524,6 @@ export default class ScanbotSDK {
|
|
|
463
524
|
readonly _type?: "DefaultContentValidator";
|
|
464
525
|
allowedCharacters?: string;
|
|
465
526
|
_marker?: () => void;
|
|
466
|
-
} | {
|
|
467
|
-
readonly _type?: "PresetContentValidator";
|
|
468
|
-
preset?: "VEHICLE_IDENTIFICATION_NUMBER";
|
|
469
|
-
_marker?: () => void;
|
|
470
527
|
} | {
|
|
471
528
|
readonly _type?: "PatternContentValidator";
|
|
472
529
|
allowedCharacters?: string;
|
|
@@ -475,25 +532,36 @@ export default class ScanbotSDK {
|
|
|
475
532
|
_marker?: () => void;
|
|
476
533
|
};
|
|
477
534
|
_marker?: () => void;
|
|
478
|
-
}) => Promise<ObjectId<"
|
|
479
|
-
|
|
535
|
+
}) => Promise<ObjectId<"TextPatternScanner">>;
|
|
536
|
+
scanTextLine: <ImageType_3 extends Image>(scannerToken: ObjectId<"TextPatternScanner">, image: ImageType_3) => Promise<TextPatternScannerTypes.TextPatternScannerResult & {
|
|
480
537
|
originalImage: ImageType_3;
|
|
481
538
|
}>;
|
|
482
|
-
|
|
539
|
+
cleanTextLineScanningQueue: (scannerToken: ObjectId<"TextPatternScanner">) => Promise<void>;
|
|
540
|
+
createVinScanner: (configuration: {
|
|
541
|
+
extractVINFromBarcode?: boolean;
|
|
542
|
+
ocrResolutionLimit?: number;
|
|
543
|
+
maximumNumberOfAccumulatedFrames?: number;
|
|
544
|
+
minimumNumberOfRequiredFramesWithEqualRecognitionResult?: number;
|
|
545
|
+
_marker?: () => void;
|
|
546
|
+
}) => Promise<ObjectId<"VinScanner">>;
|
|
547
|
+
scanVin: <ImageType_4 extends Image>(scannerToken: ObjectId<"VinScanner">, image: ImageType_4) => Promise<VinScannerTypes.VinScannerResult & {
|
|
548
|
+
originalImage: ImageType_4;
|
|
549
|
+
}>;
|
|
550
|
+
cleanVinScanningQueue: (scannerToken: ObjectId<"VinScanner">) => Promise<void>;
|
|
483
551
|
createDocumentQualityAnalyzer: (options: {
|
|
484
|
-
|
|
552
|
+
qualityThresholds?: {
|
|
485
553
|
readonly symbolQuality?: number;
|
|
486
554
|
readonly symbolRatio?: number;
|
|
487
555
|
_marker?: () => void;
|
|
488
556
|
}[];
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
557
|
+
qualityIndices?: DocumentQualityAnalyzerTypes.DocumentQuality[];
|
|
558
|
+
detectOrientation?: boolean;
|
|
559
|
+
maxImageSize?: number;
|
|
492
560
|
minEstimatedNumberOfSymbolsForDocument?: number;
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
561
|
+
minProcessedFraction?: number;
|
|
562
|
+
maxProcessedFraction?: number;
|
|
563
|
+
earlyStopIfNSymbolsFound?: number;
|
|
564
|
+
tileSize?: number;
|
|
497
565
|
_marker?: () => void;
|
|
498
566
|
}) => Promise<ObjectId<"DocumentQualityAnalyzer">>;
|
|
499
567
|
documentQualityAnalyzerAnalyze: (dqaToken: ObjectId<"DocumentQualityAnalyzer">, image: Image) => Promise<DocumentQualityAnalyzerTypes.DocumentQualityAnalyzerResult>;
|
|
@@ -501,7 +569,7 @@ export default class ScanbotSDK {
|
|
|
501
569
|
imageCrop: (image: Image, polygon: [Point, Point, Point, Point]) => Promise<RawImage>;
|
|
502
570
|
imageResize: (image: Image, destinationSize: number) => Promise<RawImage>;
|
|
503
571
|
imageRotate: (image: Image, rotations: ImageTypes.ImageRotation) => Promise<RawImage>;
|
|
504
|
-
|
|
572
|
+
documentDataExtractorCreate: (parameters: {
|
|
505
573
|
resultAccumulationConfig?: {
|
|
506
574
|
confirmationMethod?: Config.FrameAccumulationTypes.ConfirmationMethod;
|
|
507
575
|
minConfirmations?: number;
|
|
@@ -511,40 +579,38 @@ export default class ScanbotSDK {
|
|
|
511
579
|
};
|
|
512
580
|
fieldExcludeList?: string[];
|
|
513
581
|
configurations?: ({
|
|
514
|
-
readonly _type?: "
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
582
|
+
readonly _type?: "DateValidationConfiguration";
|
|
583
|
+
minYear?: number;
|
|
584
|
+
maxYear?: number;
|
|
585
|
+
fieldTypeName?: string;
|
|
518
586
|
_marker?: () => void;
|
|
519
587
|
} | {
|
|
520
|
-
readonly _type?: "
|
|
521
|
-
|
|
588
|
+
readonly _type?: "EuropeanHealthInsuranceCardConfiguration";
|
|
589
|
+
expectedCountry?: Config.DocumentDataExtractorConfigurationTypes.EuropeanHealthInsuranceCardIssuingCountry;
|
|
522
590
|
_marker?: () => void;
|
|
523
591
|
} | {
|
|
524
|
-
readonly _type?: "
|
|
525
|
-
|
|
526
|
-
|
|
592
|
+
readonly _type?: "MRZFallbackConfiguration";
|
|
593
|
+
acceptedCountries?: string[];
|
|
594
|
+
acceptedMRZTypes?: MrzTypes.MrzDocumentType[];
|
|
527
595
|
_marker?: () => void;
|
|
528
596
|
} | {
|
|
529
|
-
readonly _type?: "
|
|
530
|
-
|
|
597
|
+
readonly _type?: "DocumentDataExtractorCommonConfiguration";
|
|
598
|
+
acceptedDocumentTypes?: string[];
|
|
531
599
|
_marker?: () => void;
|
|
532
600
|
})[];
|
|
533
601
|
_marker?: () => void;
|
|
534
|
-
}) => Promise<ObjectId<"
|
|
535
|
-
|
|
536
|
-
mode?:
|
|
602
|
+
}) => Promise<ObjectId<"DocumentDataExtractor">>;
|
|
603
|
+
documentDataExtractorExtract: <ImageType_5 extends Image>(gdrToken: ObjectId<"DocumentDataExtractor">, image: ImageType_5, parameters: {
|
|
604
|
+
mode?: DocumentDataExtractorTypes.DocumentDataExtractionMode;
|
|
537
605
|
_marker?: () => void;
|
|
538
|
-
}) => Promise<
|
|
539
|
-
originalImage:
|
|
606
|
+
}) => Promise<DocumentDataExtractorTypes.DocumentDataExtractionResult & {
|
|
607
|
+
originalImage: ImageType_5;
|
|
540
608
|
}>;
|
|
541
609
|
version: () => Promise<string>;
|
|
542
610
|
__hasModuleFunction: (functionName: string) => Promise<any>;
|
|
543
611
|
__callModuleFunction: (functionName: string, args?: any[]) => Promise<any>;
|
|
544
612
|
};
|
|
545
613
|
private licenseCheck;
|
|
546
|
-
/** @param partialConfig {@displayType `DeepPartial<GenericTextLineScannerTypes.ScannerConfiguration>`} {@link GenericTextLineScannerTypes.ScannerConfiguration}*/
|
|
547
|
-
private createGenericTextLineScanner;
|
|
548
614
|
/**
|
|
549
615
|
* This method will destroy all web workers and free the memory held by the
|
|
550
616
|
* SDK (after the next run of the garbage collector).
|