Merge branch 'development'

Author: RobinFarmer

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.3
+
+* Bumped Android to 4.0.8
+* Bumped iOS to 2.0.6
+* Added method `purge()`.
+* Added setup options `PerformOnDeviceOCR` and `OutputFormat`.
+
 ## 1.0.2
 
 * Bumped Android to 4.0.6

README.md

@@ -168,6 +168,12 @@ KlippaScannerSDK.getCameraPermission().then((authStatus) => {
 
         // What the default color conversion will be (grayscale, original, enhanced).
         DefaultColor: "original",
+
+        // Whether to perform on-device OCR after scanning completes.
+        PerformOnDeviceOCR: false,
+
+        // What the output format will be (jpeg, pdfMerged, pdfSingle). (Default jpeg)
+        OutputFormat: "jpeg",
 
         // Optional. Only affects Android.
 
@@ -385,6 +391,12 @@ CameraModeMulti: {name: "Name", message: "Message", image: "{name of image in As
 CameraModeSegmented: {name: "Name", message: "Message", image: "{name of image in Assets.xcassets}"}
 ```
 
+## How to clear the storage.
+
+```javascript
+KlippaScannerSDK.purge()
+```
+
 ## Important iOS notes
 Older iOS versions do not ship the Swift libraries. To make sure the SDK works on older iOS versions, you can configure the build to embed the Swift libraries using the build setting `EMBEDDED_CONTENT_CONTAINS_SWIFT = YES`.
 

android/build.gradle

@@ -88,7 +88,7 @@ repositories {
 }
 
 dependencies {
-    def fallbackKlippaScannerVersion = "4.0.6"
+    def fallbackKlippaScannerVersion = "4.0.8"
     def klippaScannerVersion = project.hasProperty('klippaScannerVersion') ? project.klippaScannerVersion : fallbackKlippaScannerVersion
 
     //noinspection GradleDynamicVersion

android/src/main/java/com/klippa/reactscanner/KlippaScannerSDKModule.kt

@@ -25,10 +25,12 @@ import com.klippa.scanner.model.KlippaError
 import com.klippa.scanner.model.KlippaImageColor
 import com.klippa.scanner.model.KlippaMultipleDocumentMode
 import com.klippa.scanner.model.KlippaObjectDetectionModel
+import com.klippa.scanner.model.KlippaOutputFormat
 import com.klippa.scanner.model.KlippaScannerResult
 import com.klippa.scanner.model.KlippaSegmentedDocumentMode
 import com.klippa.scanner.model.KlippaSingleDocumentMode
 import com.klippa.scanner.model.KlippaSize
+import com.klippa.scanner.storage.KlippaStorage
 
 class KlippaScannerSDKModule(
     private val reactContext: ReactApplicationContext
@@ -95,6 +97,12 @@ class KlippaScannerSDKModule(
         reactContext.addActivityEventListener(activityEventListener)
     }
 
+    @ReactMethod
+    fun purge(promise: Promise) {
+        KlippaStorage.purge(reactContext)
+        promise.resolve(null)
+    }
+
     @ReactMethod
     fun getCameraPermission(promise: Promise) {
         val map: WritableMap = WritableNativeMap()
@@ -143,7 +151,21 @@ class KlippaScannerSDKModule(
                 when (config.getString("DefaultColor")) {
                     "grayscale" -> scannerSession.imageAttributes.imageColorMode = KlippaImageColor.GRAYSCALE
                     "enhanced" -> scannerSession.imageAttributes.imageColorMode = KlippaImageColor.ENHANCED
-                    else -> scannerSession.imageAttributes.imageColorMode = KlippaImageColor.ORIGINAL
+                    "original" -> scannerSession.imageAttributes.imageColorMode = KlippaImageColor.ORIGINAL
+                }
+            }
+
+            if (config.hasKey("OutputFormat")) {
+                when (config.getString("OutputFormat")) {
+                    "jpeg" -> {
+                        scannerSession.imageAttributes.outputFormat = KlippaOutputFormat.JPEG
+                    }
+                    "pdfSingle" -> {
+                        scannerSession.imageAttributes.outputFormat = KlippaOutputFormat.PDF_SINGLE
+                    }
+                    "pdfMerged" -> {
+                        scannerSession.imageAttributes.outputFormat = KlippaOutputFormat.PDF_MERGED
+                    }
                 }
             }
 
@@ -163,6 +185,10 @@ class KlippaScannerSDKModule(
                 }
             }
 
+            if (config.hasKey("PerformOnDeviceOCR")) {
+                scannerSession.imageAttributes.performOnDeviceOCR = config.getBoolean("PerformOnDeviceOCR")
+            }
+            
             if (config.hasKey("ImageLimit")) {
                 scannerSession.imageAttributes.imageLimit = config.getInt("ImageLimit")
             }
@@ -347,8 +373,8 @@ class KlippaScannerSDKModule(
                 }
 
                 val cameraModes = KlippaCameraModes(
-                        modes = modes,
-                        startingIndex = index
+                    modes = modes,
+                    startingIndex = index
                 )
 
                 scannerSession.cameraModes = cameraModes
@@ -367,7 +393,7 @@ class KlippaScannerSDKModule(
         val cameraResult: WritableMap = WritableNativeMap()
         val images: WritableArray = WritableNativeArray()
 
-        val imageList = result.images
+        val imageList = result.results
         val crop = result.cropEnabled
         val timerEnabled = result.timerEnabled
         val color = result.defaultImageColorLegacy

ios/.sdk_version

@@ -1 +1 @@
-2.0.5
+2.0.6

ios/KlippaScannerSDK.swift

@@ -151,15 +151,31 @@ class KlippaScannerSDK: NSObject {
         }
 
         if let imageColor = config["DefaultColor"] as? String {
-            if(imageColor == "grayscale") {
-                builder.klippaColors.imageColor = KlippaImageColor.grayscale
-            } else if(imageColor == "enhanced") {
+            switch imageColor {
+            case "original":
+                builder.klippaColors.imageColor = KlippaImageColor.original
+            case "grayscale":
+                 builder.klippaColors.imageColor = KlippaImageColor.grayscale
+            case "enhanced":
                 builder.klippaColors.imageColor = KlippaImageColor.enhanced
-            } else {
+            default:
                 builder.klippaColors.imageColor = KlippaImageColor.original
             }
         }
 
+        if let outputFormat = config["OutputFormat"] as? String {
+            switch outputFormat {
+            case "jpeg":
+                builder.klippaImageAttributes.outputFormat = .jpeg
+            case "pdfSingle":
+                builder.klippaImageAttributes.outputFormat = .pdfSingle
+            case "pdfMerged":
+                builder.klippaImageAttributes.outputFormat = .pdfMerged
+            default:
+                builder.klippaImageAttributes.outputFormat = .jpeg
+            }
+        }
+
         if let moveCloserMessage = config["MoveCloserMessage"] as? String {
             builder.klippaMessages.moveCloserMessage = moveCloserMessage
         }
@@ -321,6 +337,10 @@ class KlippaScannerSDK: NSObject {
             builder.klippaImageAttributes.storeImagesToCameraRoll = storeImagesToCameraRoll
         }
 
+        if let performOnDeviceOCR = config["PerformOnDeviceOCR"] as? Bool {
+            builder.klippaImageAttributes.performOnDeviceOCR = performOnDeviceOCR
+        }
+
         if let userCanPickMediaFromStorage = config["UserCanPickMediaFromStorage"] as? Bool {
             builder.klippaMenu.userCanPickMediaFromStorage = userCanPickMediaFromStorage
         }
@@ -496,7 +516,7 @@ extension KlippaScannerSDK: KlippaScannerDelegate {
     func klippaScannerDidFinishScanningWithResult(result: KlippaScanner.KlippaScannerResult) {
 
         var images = [Dictionary<String, String>]()
-        for image in result.images {
+        for image in result.results {
 
             let path = image.path
             let imageDict = ["Filepath": path]

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@klippa/react-native-klippa-scanner-sdk",
   "title": "React Native Klippa Scanner SDK",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Allows you to take pictures with the Klippa Scanner SDK from React Native.",
   "main": "index.js",
   "files": [

types/index.d.ts

@@ -131,14 +131,20 @@ export class CameraConfig {
   // Whether the user must confirm the taken photo before the SDK continues.
   UserShouldAcceptResultToContinue: boolean;
 
+  // What the default color conversion will be (original, grayscale, enhanced).
+  DefaultColor?: 'original' | 'grayscale' | 'enhanced';
+
+  // What the output format will be (jpeg, pdfMerged, pdfSingle). (Default jpeg)
+  OutputFormat?: 'jpeg' | 'pdfMerged' | 'pdfSingle';
+
+  // Whether to perform on-device OCR after scanning completes.
+  PerformOnDeviceOCR: boolean;
+
   // Android options.
 
   // Where to put the image results.
   StoragePath?: string;
 
-  // What the default color conversion will be (original, grayscale, enhanced).
-  DefaultColor?: 'original' | 'grayscale' | 'enhanced';
-
   OutputFilename?: string;
 
   // The threshold sensitive the motion detection is. (lower value is higher sensitivity, default 50).
@@ -270,9 +276,9 @@ export class CameraResultImage {
 }
 
 export class CameraPermissionResult {
-  // Android always return Authorized, the SDK itself asks for permission.
   Status: 'Authorized' | 'Denied' | 'Restricted';
 }
 
 export declare function getCameraPermission(): Promise<CameraPermissionResult>;
-export declare function getCameraResult(config: CameraConfig): Promise<CameraResult>;
+export declare function getCameraResult(config: CameraConfig): Promise<CameraResult>;
+export declare function purge(): Promise<void>;