Merge pull request #24 from klippa-app/development

Development

Author: RobinFarmer

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.8
+
+* Bump Android to 0.7.5
+* Bump iOS to 0.5.18
+* Added `German` and `French` support.
+* Added `enableAutoCapture` to `IdentityBuilder`.
+* Added `validationIncludeList` and `validationExcludeList` to `IdentityBuilder`.
+
 ## 0.2.7
 
 * Bump Android to 0.7.3

README.md

@@ -148,6 +148,14 @@ To display extra debug info, add the following to the builder:
 identityBuilder.isDebug = true;
 ```
 
+### Enable Auto Capture
+
+To configure if the camera should automatically take a photo if the conditions are right.
+
+```dart
+identityBuilder.enableAutoCapture = true;
+```
+
 ### Intro/Success screens
 
 To configure whether to show intro/success screens, add the following to the builder:
@@ -169,7 +177,7 @@ identityBuilder.retryThreshold = 1;
 Add the following to the builder:
 
 ```dart
-// We support English, Dutch and Spanish.
+// We support English, Dutch, Spanish, German and French.
 identityBuilder.language = KIVLanguage.Dutch;
 ```
 
@@ -205,6 +213,28 @@ identityBuilder.verifyIncludeList = [
 identityBuilder.verifyExcludeList = [];
 ```
 
+### Validation Include & Exclude lists
+
+You can edit the validation include list: the failed validations that are shown to the user Or the validation exclude list: the failed validations that are hidden from the user.
+For more information regarding validations check out the [API documentation](https://custom-ocr.klippa.com/docs#tag/IdentityVerification/operation/createIdentityVerificationSession). 
+
+```dart
+identityBuilder.validationIncludeList = [
+    "DetectFace",
+    "CompareFace",
+    "DetectSignature",
+    "CompareSignature",
+    "CheckRequiredField",
+    "MatchSidesFront",
+    "MatchSidesBack",
+    "FieldValidation",
+    "MatchVizMrz",
+    "MrzChecksum"
+]
+
+identityBuilder.validationExcludeList = []
+```
+
 ## How to change the colors of the SDK?
 
 ### Android

android/build.gradle

@@ -53,6 +53,6 @@ android {
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    def klippaIdentityVerificationVersion = project.hasProperty('klippaIdentityVerificationVersion') ? project.klippaIdentityVerificationVersion : "0.7.3"
+    def klippaIdentityVerificationVersion = project.hasProperty('klippaIdentityVerificationVersion') ? project.klippaIdentityVerificationVersion : "0.7.5"
     implementation "com.klippa:identity_verification:$klippaIdentityVerificationVersion"
 }

android/src/main/kotlin/com/klippa/identity_verification/klippa_identity_verification_sdk/KlippaIdentityVerificationSdkPlugin.kt

@@ -96,6 +96,12 @@ class KlippaIdentityVerificationSdkPlugin : FlutterPlugin, MethodCallHandler, Ac
                     "KIVLanguage.Spanish" -> {
                         identitySession.language = IdentitySession.KIVLanguage.Spanish
                     }
+                    "KIVLanguage.German" -> {
+                        identitySession.language = IdentitySession.KIVLanguage.German
+                    }
+                    "KIVLanguage.French" -> {
+                        identitySession.language = IdentitySession.KIVLanguage.French
+                    }
                 }
             }
 
@@ -111,6 +117,10 @@ class KlippaIdentityVerificationSdkPlugin : FlutterPlugin, MethodCallHandler, Ac
                 identitySession.isDebug = isDebug
             }
 
+            call.argument<Boolean>("EnableAutoCapture")?.let { enableAutoCapture ->
+                identitySession.enableAutoCapture = enableAutoCapture
+            }
+
             call.argument<List<String>>("VerifyIncludeList")?.let { include ->
                 identitySession.kivIncludeList = include
             }
@@ -119,6 +129,14 @@ class KlippaIdentityVerificationSdkPlugin : FlutterPlugin, MethodCallHandler, Ac
                 identitySession.kivExcludeList = exclude
             }
 
+            call.argument<List<String>>("ValidationIncludeList")?.let { include ->
+                identitySession.kivValidationIncludeList = include
+            }
+
+            call.argument<List<String>>("ValidationExcludeList")?.let { exclude ->
+                identitySession.kivValidationExcludeList = exclude
+            }
+
             call.argument<Int>("RetryThreshold")?.let { retryThreshold ->
                 identitySession.retryThreshold = retryThreshold
             }
@@ -154,7 +172,8 @@ class KlippaIdentityVerificationSdkPlugin : FlutterPlugin, MethodCallHandler, Ac
             IdentitySessionResultCode.DEVICE_DOES_NOT_SUPPORT_NFC,
             IdentitySessionResultCode.DEVICE_NFC_DISABLED,
             IdentitySessionResultCode.TAKING_PHOTO_FAILED,
-            IdentitySessionResultCode.UNKNOWN_ERROR -> identityVerificationCanceled(mappedResultCode.message())
+            IdentitySessionResultCode.UNKNOWN_ERROR,
+            IdentitySessionResultCode.INCORRECT_SESSION_SETUP -> identityVerificationCanceled(mappedResultCode.message())
         }
 
         return true

ios/Classes/SwiftKlippaIdentityVerificationSdkPlugin.swift

@@ -45,6 +45,10 @@ public class SwiftKlippaIdentityVerificationSdkPlugin: NSObject, FlutterPlugin,
                 builder.kivLanguage = IdentityBuilder.KIVLanguage.Dutch
             } else if (language == "KIVLanguage.Spanish") {
                 builder.kivLanguage = IdentityBuilder.KIVLanguage.Spanish
+            } else if (language == "KIVLanguage.German") {
+                builder.kivLanguage = IdentityBuilder.KIVLanguage.German
+            } else if (language == "KIVLanguage.French") {
+                builder.kivLanguage = IdentityBuilder.KIVLanguage.French
             }
         }
 
@@ -60,32 +64,35 @@ public class SwiftKlippaIdentityVerificationSdkPlugin: NSObject, FlutterPlugin,
             builder.isDebug = isDebug
         }
 
+        if let enableAutoCapture = builderArgs["EnableAutoCapture"] as? Bool {
+            builder.enableAutoCapture = enableAutoCapture
+        }
         if let textColor = builderArgs["Colors.textColor"] as? String {
-            builder.kivColors.textColor = hexColorToUIColor(hex: textColor)
+            builder.kivColors.textColor = UIColor(hexString: textColor) 
         }
 
         if let backgroundColor = builderArgs["Colors.backgroundColor"] as? String {
-            builder.kivColors.backgroundColor = hexColorToUIColor(hex: backgroundColor)
+            builder.kivColors.backgroundColor = UIColor(hexString: backgroundColor)
         }
 
         if let buttonSuccessColor = builderArgs["Colors.buttonSuccessColor"] as? String {
-            builder.kivColors.buttonSuccessColor = hexColorToUIColor(hex: buttonSuccessColor)
+            builder.kivColors.buttonSuccessColor = UIColor(hexString: buttonSuccessColor)
         }
 
         if let buttonErrorColor = builderArgs["Colors.buttonErrorColor"] as? String {
-            builder.kivColors.buttonErrorColor = hexColorToUIColor(hex: buttonErrorColor)
+            builder.kivColors.buttonErrorColor = UIColor(hexString: buttonErrorColor)
         }
 
         if let buttonOtherColor = builderArgs["Colors.buttonOtherColor"] as? String {
-            builder.kivColors.buttonOtherColor = hexColorToUIColor(hex: buttonOtherColor)
+            builder.kivColors.buttonOtherColor = UIColor(hexString: buttonOtherColor)
         }
 
         if let progressBarBackground = builderArgs["Colors.progressBarBackground"] as? String {
-            builder.kivColors.progressBarBackground = hexColorToUIColor(hex: progressBarBackground)
+            builder.kivColors.progressBarBackground = UIColor(hexString: progressBarBackground)
         }
 
         if let progressBarForeground = builderArgs["Colors.progressBarForeground"] as? String {
-            builder.kivColors.progressBarForeground = hexColorToUIColor(hex: progressBarForeground)
+            builder.kivColors.progressBarForeground = UIColor(hexString: progressBarForeground)
         }
 
         if let fontName = builderArgs["Fonts.fontName"] as? String {
@@ -104,6 +111,14 @@ public class SwiftKlippaIdentityVerificationSdkPlugin: NSObject, FlutterPlugin,
             builder.kivVerifyExcludeList = excludeList
         }
 
+        if let validationIncludeList = builderArgs["ValidationIncludeList"] as? [String] {
+            builder.kivValidationIncludeList = validationIncludeList
+        }
+
+        if let validationExcludeList = builderArgs["ValidationExcludeList"] as? [String] {
+            builder.kivValidationExcludeList = validationExcludeList
+        }
+
         if let retryThreshold = builderArgs["RetryThreshold"] as? Int {
             builder.retryThreshold = retryThreshold
         }
@@ -115,28 +130,6 @@ public class SwiftKlippaIdentityVerificationSdkPlugin: NSObject, FlutterPlugin,
         rootViewController.present(viewController, animated:true, completion:nil)
     }
 
-    private func hexColorToUIColor(hex: String) -> UIColor? {
-        let r, g, b, a: CGFloat
-        
-        let start = hex.index(hex.startIndex, offsetBy: 1)
-        let hexColor = String(hex[start...])
-        
-        if hexColor.count == 8 {
-            let scanner = Scanner(string: hexColor)
-            var hexNumber: UInt64 = 0
-            
-            if scanner.scanHexInt64(&hexNumber) {
-                a = CGFloat((hexNumber & 0xff000000) >> 24) / 255
-                r = CGFloat((hexNumber & 0x00ff0000) >> 16) / 255
-                g = CGFloat((hexNumber & 0x0000ff00) >> 8) / 255
-                b = CGFloat(hexNumber & 0x000000ff) / 255
-                
-                return UIColor.init(red: r, green: g, blue: b, alpha: a)
-            }
-        }
-        return nil
-    }
-
     public func identityVerificationFinished() {
         let resultMap = Dictionary<String, Any>.init()
         resultHandler!(resultMap)
@@ -170,3 +163,32 @@ public class SwiftKlippaIdentityVerificationSdkPlugin: NSObject, FlutterPlugin,
     }
 
 }
+
+extension UIColor {
+    convenience init(hexString: String) {
+        var newString = hexString
+        if newString.first != "#" {
+            newString.insert("#", at: newString.startIndex)
+        }
+        let hex = newString.trimmingCharacters(in: CharacterSet.alphanumerics.inverted)
+        var int = UInt64()
+        Scanner(string: hex).scanHexInt64(&int)
+        let a, r, g, b: UInt64
+        switch hex.count {
+        case 3: // RGB (12-bit)
+            (a, r, g, b) = (255, (int >> 8) * 17, (int >> 4 & 0xF) * 17, (int & 0xF) * 17)
+        case 6: // RGB (24-bit)
+            (a, r, g, b) = (255, int >> 16, int >> 8 & 0xFF, int & 0xFF)
+        case 8: // ARGB (32-bit)
+            (a, r, g, b) = (int >> 24, int >> 16 & 0xFF, int >> 8 & 0xFF, int & 0xFF)
+        default:
+            (a, r, g, b) = (255, 0, 0, 0)
+        }
+        self.init(
+            red: CGFloat(r) / 255,
+            green: CGFloat(g) / 255,
+            blue: CGFloat(b) / 255,
+            alpha: CGFloat(a) / 255
+        )
+    }
+}

ios/sdk_version

@@ -1 +1 @@
-0.5.14
+0.5.18

lib/klippa_identity_verification_sdk.dart

@@ -2,7 +2,7 @@ import 'dart:async';
 import 'package:flutter/services.dart';
 
 /// Available languages for the Identity Verification SDK.
-enum KIVLanguage { English, Dutch, Spanish }
+enum KIVLanguage { English, Dutch, Spanish, German, French }
 
 /// Custom fonts for the SDK.
 class KIVFonts {
@@ -51,6 +51,12 @@ class IdentityBuilder {
   /// The list of items to exclude in the data verification screen.
   List<String>? verifyExcludeList;
 
+  /// The list of validations to include.
+  List<String>? validationIncludeList;
+
+  /// The list of validations to exclude.
+  List<String>? validationExcludeList;
+
   /// The language that the SDK uses.
   KIVLanguage? language;
 
@@ -63,6 +69,9 @@ class IdentityBuilder {
   /// Whether the SDK should report debug information.
   bool? isDebug;
 
+  /// Whether the SDK should automatically take photos when conditions are right.
+  bool? enableAutoCapture;
+
   /// The threshold the user can attempt a task before a contact support button is shown.
   int? retryThreshold;
 
@@ -165,6 +174,10 @@ class KlippaIdentityVerificationSdk {
       parameters['IsDebug'] = builder.isDebug;
     }
 
+    if (builder.enableAutoCapture != null) {
+      parameters['EnableAutoCapture'] = builder.enableAutoCapture;
+    }
+
     if (builder.verifyIncludeList != null) {
       parameters['VerifyIncludeList'] = builder.verifyIncludeList;
     }
@@ -173,6 +186,14 @@ class KlippaIdentityVerificationSdk {
       parameters['VerifyExcludeList'] = builder.verifyExcludeList;
     }
 
+    if (builder.validationIncludeList != null) {
+      parameters['ValidationIncludeList'] = builder.validationIncludeList;
+    }
+
+    if (builder.validationExcludeList != null) {
+      parameters['ValidationExcludeList'] = builder.validationExcludeList;
+    }
+
     if (builder.retryThreshold != null) {
       parameters["RetryThreshold"] = builder.retryThreshold;
     }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: klippa_identity_verification_sdk
 description: Allows you to do identity verification with the Klippa Identity Verification SDK from Flutter apps.
-version: 0.2.7
+version: 0.2.8
 homepage: https://github.com/klippa-app/flutter-klippa-identity-verification-sdk
 
 environment: