Release 4.0.0 - Bump up SDK version to 4.0.0

Addressed breaking change: replacing the microblink maven url with the
regulaforensics one in build.gradle.

Related to DEP-571

Author: mircea-yoti

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+## [4.0.0] - 2025-03-11
+### Changed
+- Document processing improvements. This introduces a small breaking change requiring replacing the
+  "microblink" maven url with the "regulaforensics" one in your allProjects entry in your root build.gradle
+  file (see README - Setup the SDK). You can also remove any "microblink"-related proguard rules you have.
+- Addressed compatibility issues when building with Android Gradle Plugin 8+
+- Various bug fixes and improvements
+
 ## [3.5.2] - 2024-09-12
 - Updated internal dependency version
 

README.md

@@ -33,19 +33,20 @@ We strongly recommend you to migrate your app to the new Androidx libraries: htt
 
 ## Setup the SDK
 
-Make sure you have mavenCentral and microblink repository added in your allProjects entry in your root build.gradle:
+Make sure you have mavenCentral and regulaforensics repository added in your allProjects entry in your root build.gradle:
 
 ```groovy
 allprojects {
     repositories {
         mavenCentral()
-        maven { url 'https://maven.microblink.com' }
+        maven { url "https://maven.regulaforensics.com/RegulaDocumentReader" }
         maven { url "https://jitpack.io" }
         ...
     }
     ...
 }
 ```
+If you are still using Yoti SDK version `3.5.2` or below, please refer to [these instructions](https://github.com/getyoti/yoti-doc-scan-android/blob/v3.5.2/README.md#setup-the-sdk) instead, but keep in mind that support for older versions is not guaranteed and we highly recommend updating to the latest one as soon as possible.
 
 The Yoti SDK is composed of multiple feature modules. Each feature is optional, but you must include at least one to use the SDK.
 
@@ -55,20 +56,20 @@ Add modules you require to your build.gradle:
 ```groovy
 dependencies {
     //If you need document capture
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:4.0.0'
     //Or if you want the version without OCR and NFC capture, which is ~15Mb smaller in size
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-slim:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-slim:4.0.0'
 
     //If you need supplementary documents
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:4.0.0'
 
     //If you need liveness
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:4.0.0'
 
     //If you need selfie capture
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture:4.0.0'
     //Or if you want the version without an embedded AI model, which is ~20 MB smaller in size
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:4.0.0'
 }
 ```
 

app/build.gradle

@@ -7,8 +7,8 @@ android {
         applicationId "com.yoti.mobile.android.sdk.yotidocscan.sample"
         minSdkVersion 21
         targetSdkVersion 33
-        versionCode 352
-        versionName "3.5.2"
+        versionCode 400
+        versionName "4.0.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
 
@@ -46,13 +46,13 @@ dependencies {
     implementation 'androidx.appcompat:appcompat:1.4.1'
     implementation 'androidx.core:core-ktx:1.7.0'
 
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:4.0.0'
 //    Alternative version without OCR and NFC capture, ~15Mb smaller in size
-//    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-slim:3.5.2'
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:3.5.2'
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:3.5.2'
+//    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-slim:4.0.0'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:4.0.0'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:4.0.0'
 //    Version with an embedded AI model
-    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture:3.5.2'
+    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture:4.0.0'
 //    Alternative version without an embedded AI model, ~20 MB smaller in size
-//    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:3.5.2'
+//    implementation 'com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:4.0.0'
 }

app/proguard-rules.pro

@@ -2,9 +2,6 @@
     volatile <fields>;
 }
 -keep class com.yoti.** { *; }
--keep class com.microblink.** { *; }
--keep class com.microblink.**$* { *; }
--dontwarn com.microblink.**
 -dontwarn com.facetec.sdk.**
 -keep class com.facetec.sdk.** { *; }
 -dontwarn javax.annotation.Nullable

build.gradle

@@ -18,7 +18,7 @@ allprojects {
     repositories {
         google()
         mavenCentral()
-        maven { url 'https://maven.microblink.com' }
+        maven { url "https://maven.regulaforensics.com/RegulaDocumentReader" }
         maven { url "https://jitpack.io" }
     }
 }