Skip to main content

Changelog | Cordova Document Scanner

Version 4.x#

Version 4.11.1 (17 Sep 2021):#

  • ๐Ÿž Bug fixes:
    • Android: fixed msiPlesseyChecksumAlgorithms, stripCheckDigits and cameraZoom parameters being ignored in BatchBarcodeScannerConfiguration
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.87.1 (cf. changelog)

Version 4.11.0 (10 Aug 2021):#

  • ๐ŸŽ‰ New:
    • Added isCapturedAutomatically in Page interface to identify whether the image was captured automatically or manually triggered by the shutter button. Persistence of Page Objects
    • Added engineMode property of type EngineMode on barcode scanning APIs - BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration to switch between the legacy barcode engine and the new Next Generation barcode engine. By default, the new engine is used. startBarcodeScanner
    • Additional parameter msiPlesseyChecksumAlgorithms: MSIPlesseyChecksumAlgorithm in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration to specify the checksum algorithms for MSI Plessey barcodes. startBarcodeScanner
    • Changed signature of the LicenseFailure interface. Added additional parameter licenseErrorMessage : String
  • โš ๏ธ Breaking Changes:
    • Renamed the parameter enableGS1Decoding in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration as gs1DecodingEnabled. startBarcodeScanner
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.86.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.19.3 (cf. changelog)

Version 4.10.0 (26 Apr 2021):#

Version 4.9.1 (24 Mar 2021):#

  • ๐Ÿš€ Improvements:
    • Significantly improved Document Scanner result image lazy-generation
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot iOS SDK to v1.15.0

Version 4.9.0 (12 Mar 2021):#

Version 4.8.0 (26 Feb 2021):#

  • ๐ŸŽ‰ New:
    • Encryption of image and PDF files. For more details please check out the section Storage Encryption.
  • โš ๏ธ Breaking Changes:
    • The structured OCR result data is now returned as a JSON data field jsonData instead of a JSON file (jsonFileUri)

Version 4.7.0 (8 Feb 2021):#

  • ๐ŸŽ‰ New:
  • ๐Ÿš€ Improvements:
    • Data Scanner 2.0: Improved the Scanbot Data Scanner components for text recognition from European license plates and LC Dot-Matrix displays

Version 4.6.2 (21 Jan 2021):#

  • ๐Ÿš€ Improvements:
    • Added failsafe for ScanbotSDK iOS download script

Version 4.6.1 (14 Jan 2021):#

  • ๐Ÿš€ Improvements:
    • Improved detection of ITF and DataMatrix barcodes
  • ๐Ÿž Bug fixes:
    • Android: The flash button on all UI screens is not shown anymore on devices without a flashlight
    • Android: Fixed not working live detection on some devices with non-standard camera frame resolution
    • Android: Several potential fixes and checks in the Barcode Scanner UI to avoid sporadic crashes
    • Android: Fixed the "double scan" (double beep tone) issue in the Barcode Scanner UI
    • Fixed a rare case of the QR-codes processing which might lead to crash
    • Fixed incorrect processing of the text part in DataMatrix barcodes with binary data
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.77.2 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.12.3 (cf. changelog)

Version 4.6.0 (4 Dec 2020):#

  • ๐ŸŽ‰ New:
    • Added a new config property autoCancelTimeout for the Barcode Scanner UI. It provides the possibility to set a timeout value in seconds for auto-closing/cancellation of the Barcode Scanner UI.
  • ๐Ÿš€ Improvements:
    • Improved barcode scanning. Better recognition of rotated and damaged PDF417 codes
  • ๐Ÿž Bug fixes:
    • iOS: Fixed an issue about Bitcode support when submitting an app to the App Store Connect (error "ITMS-90562: Invalid Bundle - Bitcode failed to compile")
    • Android: Fixed a bug with the size of generated PDF documents being too big
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.76.2 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.12.1 (cf. changelog)

Version 4.5.0 (25 Nov 2020):#

  • ๐ŸŽ‰ New:
    • Android: Added a new optional config property useButtonsAllCaps: boolean for all RTU UI screens to control whether the buttons should use the all-capitals-style, as defined by the Android Material Design
  • ๐Ÿš€ Improvements:
    • Improvements in the detection of barcodes, especially of the type PDF417
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.76.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.11.9 (cf. changelog)

Version 4.4.0 (23 Nov 2020):#

  • ๐Ÿž Bug fixes:
    • iOS: Introduced a new API method refreshImageUris(pages) to fix image file paths after app updates. For more details please check out the section Persistence of Page Objects.

Version 4.3.1 (26 Oct 2020):#

  • ๐Ÿž Bug fixes:
    • Barcode Scanner and EHIC Scanner: fixed the ability to lock the UI to certain orientation modes
    • Removed unused config property barcodeImageGenerationType from BatchBarcodeScannerConfiguration
  • โš ๏ธ API Breaking Changes:
    • Replaced config property allowedInterfaceOrientations by orientationLockMode in BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration, HealthInsuranceCardScannerConfiguration

Version 4.3.0 (13 Oct 2020):#

  • ๐ŸŽ‰ New:
    • Batch Barcode Scanner - a new UI component to scan multiple barcodes in a row. See the new API function startBatchBarcodeScanner.
    • Blur Estimator - a new API method to detect blurriness on still images. See estimateBlur.
    • New CroppingScreenConfiguration parameters: hintTitle and hintTitleColor
  • ๐Ÿš€ Improvements:
    • Android: Some big improvements in the Document Scanner UI that make document scanning perform better and much smoother. Increased start-up time of the camera preview. Faster saving of the snapped pages. Optimized performance of the image processing for simple operations (rotate, crop, resize).
    • Android and iOS: Improved recognition of barcodes and QR-codes (live detection and from still images)
  • โš ๏ธ Breaking Changes:
    • iOS: Dropped support for iOS 9 and iOS 10!
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.74.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.11.2 (cf. changelog)

Version 4.2.2 (25 Sep 2020):#

  • ๐Ÿž Bug fixes:
    • Android: Fixed a crash during the initialization process on some devices with Android 5.1 and less
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.72.3 (see the changelog)

Version 4.2.1 (6 Aug 2020):#

  • ๐Ÿš€ Improvements:
    • iOS: Improved the download script of the iOS SDK framework in order to support the npm HTTP proxy settings

Version 4.2.0 (3 Aug 2020):#

  • ๐ŸŽ‰ New:
    • A new scanner UI component for the European Health Insurance Cards (EHIC)! See the new API function startEHICScanner
  • ๐Ÿš€ Improvements:
    • Android: HTML5 Camera for barcode detection:
      • Added ViewFinder
      • Added a new function dispose
  • ๐Ÿž Bug fixes:
    • iOS: Fixed an installation issue when downloading the iOS SDK framework
    • Android: topBarBackgroundColor now also affects the status bar in all UI components (Document Scanner UI, Cropping UI, etc)
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.71.0 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.19 (see the changelog)

Version 4.1.0 (20 Jul 2020):#

  • ๐ŸŽ‰ New:
    • Android: HTML-Based Camera & Barcode Detection
      • Canvas-based camera: await ScanbotHTMLCamera.create(container);
      • Native SDK barcode detection: camera.startBarcodeDetector(barcodeFormats, callback)
      • Camera permission utility function: await SDK.requestCameraPermission();
    • ML-Based document detection: documentDetectorMode: 'ML_BASED'
  • ๐Ÿš™ Under the hood:
    • iOS: SDK itself no longer contained in the npm package, but downloaded after npm install
    • Upgraded the native Scanbot Android SDK to v1.70.2 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.17 (see the changelog)

Version 4.0.0 (27 Mar 2020):#

  • ๐ŸŽ‰ New:
    • Updated QR- & Barcode Scanner which provides:
      • Improved detection and extraction of 1D and 2D barcodes, especially Data Matrix and PDF 417 codes
      • Support for multiple barcode detection
      • Detect barcodes on still images (e.g. JPG file). See the new function detectBarcodesOnImage()
    • New function getLicenseInfo(success: LicenseInfo, error): Now features expirationDate and status, not just validity of a license
    • setLicenseFailureHandler(callback: LicenseFailure): You now have the option to set a license failure handler so you'd know exactly when, where and why you're experiencing license issues
  • ๐Ÿ›  New Requirements:
    • Android: upped minSdkVersion to 21. The native Scanbot Android SDK now requires minSdkVersion 21 (API Level 21, Android 5.0)
    • Android: Got rid of legacy Support Libraries. The plugin and the native Scanbot Android SDK are now based on AndroidX libraries. Note that Cordova support for AndroidX requires additional plugins like cordova-plugin-androidx and cordova-plugin-androidx-adapter
  • โš ๏ธ API Breaking Changes:
    • Function isLicenseValid() was replaced by getLicenseInfo(). See getLicenseInfo() for more details.
    • The result of the Barcode Scanner UI now contains an array of detected barcodes - result.barcodes[n]. See startBarcodeScanner() for more details.
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.60.0 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.11 (see the changelog)

Version 3.x#

๐Ÿ‘‰ Legacy documentation for v3.x

Version 3.3.1 (30 Mar 2020):#

  • ๐Ÿž Bug fixes:
    • Android: Removed permission READ_PHONE_STATE used in a sub library of the native Scanbot SDK.
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.39.56.4

Version 3.3.0 (11 Feb 2020):#

  • ๐ŸŽ‰ New:
    • Android & iOS: Added support for TIFF compression types and for defining custom DPI value as TIFF meta data. See the new options compression and dpi of the writeTiff() method.
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.39.56.3.

Version 3.2.3 (4 Feb 2020):#

  • ๐Ÿš€ Improvements:
    • Android: Increased resolution of the preview images.
  • ๐Ÿž Bug fixes:
    • Android: Fixed image orientation on import in the createPage(..) method.

Version 3.2.2 (9 Oct 2019):#

  • ๐Ÿž Bug fixes:
    • iOS: Fixed modal dialog style of the Document Scanner UI, Cropping UI, Barcode Scanner UI and MRZ Scanner UI on iOS 13. All UI screens are opened in full-screen mode again.

Version 3.2.1 (22 Aug 2019):#

  • ๐Ÿž Bug fixes:
    • Android: Fixed crashes with some image filters, like BACKGROUND_CLEAN, DEEP_BINARIZATION, LOW_LIGHT_BINARIZATION, etc. on ARM 32-bit devices (armeabi-v7).
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.39.52.2 (see the changelog)

Version 3.2.0 (30 Jul 2019):#

  • ๐ŸŽ‰ New:
    • Android & iOS: New black & white Image Filter LOW_LIGHT_BINARIZATION_2.
  • ๐Ÿž Bug fixes:
    • Android: Removed permission READ_PHONE_STATE used in a sub library of the native Scanbot SDK.
    • iOS: Removed hardcoded language string in the native OCR component.
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.39.52.1 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.3 (see the changelog)
  • ๐Ÿ›  Dependencies:
    • Android: Removed dependencies to the deprecated library net.doo:doo-datamining-tools-android.

Version 3.1.0 (7 Jun 2019):#

  • ๐ŸŽ‰ New:
    • New black & white Image Filter LOW_LIGHT_BINARIZATION.
    • Added new config properties in the Document Scanner UI:
      • documentImageSizeLimit - to limit the resolution of the document image.
      • maxNumberOfPages - maximum number of pages to scan.
      • shutterButtonHidden - to hide the shutter button.
      • textHintEnergySavingActive - the text being displayed on the user-guidance label, when the scanners energy saver is activated (iOS only).
    • Android: Added native libs (.so) for the x86_64 architecture.
  • ๐Ÿš€ Improvements:
    • Improved performance of the image filter DEEP_BINARIZATION.
    • OCR - Upgraded the OCR engine to Tesseract v4.00. Improved recognition speed and quality. Please also note the Breaking Changes below.
    • OCR API - Detailed OCR results per page, including bounding boxes for words, lines and paragraphs. See OcrOutputFormat.RESULT_JSON.
  • โš ๏ธ Breaking Changes:
    • OCR Language Files - If you use the OCR feature of this plugin, please upgrade the OCR language files to Tesseract 4.00. See the OCR section of this documentation for more details.
  • ๐Ÿž Bug fixes:
    • Fixed the status of the torch light toggle button in the Document Scanner on reactivating the scanning screen.
    • Fixed a bug with the Magnifier in Cropping UI (the Magnifier was stuck in a corner)
    • Various minor bug fixes and improvements.
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.39.51 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.2 (see the changelog)

Version 3.0.1 (26 Mar 2019):#

  • ๐Ÿž Bug fixes:
    • iOS: Fixed handling of the config arguments enableCameraButtonTitle and enableCameraExplanationText in Document Scanner UI, Barcode Scanner UI and MRZ Scanner UI.

Version 3.0.0 (11 Mar 2019):#

  • ๐ŸŽ‰ NEW:
    • Android & iOS: Support for PDF page sizes (see the createPdf method).
    • Android & iOS: Added new Images Filters OTSU_BINARIZATION, DEEP_BINARIZATION and EDGE_HIGHLIGHT.
    • Android & iOS: A new config option storageBaseDirectory allows to overwrite the storage location of the native Scanbot SDKs as well as of this Plugin on initialization.
  • ๐Ÿš€ Improvements:
    • Android: Internal Storage - All components of this Plugin now use the internal storage by default, which is more secure and do not require storage permission prompts. See the Storage section of this documentation for more details.
  • โš ๏ธ Breaking changes:
    • Android: Internal Storage - In case your app is using the storage for scanned Pages as permanent storage, please make sure to implement a suitable migration. E.g. move the previous archived Page images from the old external storage folder to the new internal storage. Or alternatively overwrite the storage directory to the external folder again by using the new storageBaseDirectory config option.
  • ๐Ÿž Bug fixes:
    • iOS: Fixed a bug with missing Page meta data as result of the detectDocumentOnPage method.
    • Android & iOS: Various minor fixes and improvements.
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.39.1 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.8.6 (see the changelog)
  • ๐Ÿ›  Dependencies:
    • Android: Requires Android SDK 28, Android Support Libs 28+ (com.android.support:*). Upgrade to cordova-android@8.x is recommended or alternatively apply these gradle settings.

Version 2.x#

Version 2.1.2 (31 Jan 2019):#

  • ๐Ÿž Bug fixes:
    • iOS: Fixed handling of uiConfigs arguments in Cropping UI (polygonColor, etc).
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot iOS SDK to v1.8.4 (see the changelog)

Version 2.1.1 (25 Oct 2018):#

  • ๐Ÿž Bug fixes:
    • Android: Fixed a bug with freezing camera on Document Scanner start.
    • Android: Some layout fixes in Cropping UI (aka. inaccessible "DONE" button).
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.38.2 (see the changelog).
    • The native Scanbot Android SDK now uses the latest version of Google Play Services Vision lib v16.2.0 (com.google.android.gms:play-services-vision:16.2.0).

Version 2.1.0 (27 Sep 2018):#

  • ๐ŸŽ‰ NEW:
    • Reset/Detect functionality in Cropping UI
    • Added support for orientationLockMode in Cropping UI
  • โš ๏ธ Breaking changes:
    • Android: Added file format extension (.jpg or .png) for all Page images. Affects the new image files created by all modules like Document Scanner, Cropping UI, etc. Please note that only the new created image files will contain extensions. The currently available image files in the temporary storage of the Scanbot Plugin will not get file extensions and may become inaccessible. So please make sure to implement a suitable migration mechanism.
    • The config parameter pageCounterButtonTitle in Document Scanner now requires a placeholder "%d" for the number of pages (e.g. pageCounterButtonTitle: "%d Page(s)")
  • ๐Ÿž Bug fixes:
    • Android: Fixed an issue with camera on "Xiaomi Redmi 5 Plus" devices with MIUI Chinese ROM (#72)
    • iOS: Fixed issues with orientationLockMode in Document Scanner
  • ๐Ÿš™ Under the hood:
    • Upgraded the native Scanbot iOS SDK to v1.8.0 (see the changelog)
    • Upgraded the native Scanbot Android SDK to v1.37.0 (see the changelog)

Version 2.0.7 (28 Aug 2018):#

  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.7
    • Fixed bitcode generation

Version 2.0.6 (28 Aug 2018):#

  • Under the hood: Upgraded the native Scanbot Android SDK to v1.34.0
    • Upgraded OpenCV to 3.4.2
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.6

Version 2.0.5 (19 Jul 2018):#

  • Under the hood: Upgraded the native Scanbot Android SDK to v1.33.3
    • Removed the allowBackup flag from AndroidManifest.xml in io.scanbot:sdk-package-ui library
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.4
    • Fixed memory leaks in Document Scanner

Version 2.0.4 (18 Jul 2018):#

  • Under the hood: Upgraded the native Scanbot Android SDK to v1.33.1
  • Android: Various bug fixes and improvements in methods getFilteredDocumentPreviewUri() and applyImageFilterOnPage()
  • iOS: Added the ?minihash= query parameter in result of getFilteredDocumentPreviewUri()

Version 2.0.3 (13 Jul 2018):#

  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.3
  • iOS: Fixed a bug in PDF creation: Improved image loading for PDF and OCR.

Version 2.0.2 (12 Jul 2018):#

  • iOS: Fix property mapping of text key textHintOK
  • Android: Improved error handling of images array
  • Fixed Typings (index.d.ts)

Version 2.0.1 (11 Jul 2018):#

  • Fixed Typings (index.d.ts)
  • Android: Made code Java 1.6 compatible (sourceCompatibility 1.6)

Version 2.0.0 (5 Jul 2018):#

  • New Document Scanner UI, Cropping UI and Barcode Scanner UI - based on the native Ready-To-Use UI Components of the Scanbot SDK for Android and iOS.
  • Multi-page scanning in Document Scanner UI
  • MRZ Scanner UI
  • TIFF support: provides creation of 1-bit TIFF images with multi-page support
  • New image filter types:
    • PURE_BINARIZED - Creates an image with pixel values set to either pure black or pure white.
    • BACKGROUND_CLEAN - Cleans up the background and tries to preserve photos within the image.
    • BLACK_AND_WHITE - Black and white filter with background cleaning. Creates a grayscaled 8-bit image with mostly black or white pixels.
  • Under the hood: Upgraded the native Scanbot Android SDK to v1.33.0:
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.2:
    • Dropped support for iOS 8
  • Minor bug fixes and improvements

Version 1.x#

See the legacy v1.x documentation