Merge pull request #55 from getyoti/DEP-571

[DEP-571] Release 4.0.0

Author: mircea-yoti

CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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 for users of the
+  `yoti-sdk-doc-scan` module, 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,20 +33,24 @@ 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 the mavenCentral repository added in your allProjects entry in your root build.gradle file. If you are using the `yoti-sdk-doc-scan` module, you will also need to add the regulaforensics repository:
 
 ```groovy
 allprojects {
     repositories {
         mavenCentral()
-        maven { url 'https://maven.microblink.com' }
+        maven { url "https://maven.regulaforensics.com/RegulaDocumentReader" }
         maven { url "https://jitpack.io" }
         ...
     }
     ...
 }
 ```
 
+Note: If instead you are using the `yoti-sdk-doc-scan-slim` module, you do not need to add the regulaforensics repository.
+
+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.
 
 The modules you include must match those requested by your backend. Attempts to use a module you haven't included will fail at runtime with a [600x response code](#possible-status-for-the-session).
@@ -55,20 +59,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

@@ -2,13 +2,15 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 
 android {
+    namespace "com.yoti.mobile.android.sdk.yotidocscan.sample"
+
     compileSdk 33
     defaultConfig {
         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"
     }
 
@@ -18,8 +20,8 @@ android {
     }
 
     compileOptions {
-        sourceCompatibility = '1.8'
-        targetCompatibility = '1.8'
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
     }
 
     buildFeatures {
@@ -46,13 +48,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

app/src/main/AndroidManifest.xml

@@ -1,5 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.yoti.mobile.android.sdk.yotidocscan.sample">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <application
         android:allowBackup="true"

build.gradle

@@ -7,7 +7,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.4.2'
+        classpath 'com.android.tools.build:gradle:8.8.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
@@ -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" }
     }
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Thu Apr 25 10:22:36 EEST 2024
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

webapp/build.gradle

@@ -2,20 +2,28 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion 29
+    namespace "com.yoti.mobile.android.sdk.yotidocscan.websample"
+
+    compileSdk 33
 
     defaultConfig {
         applicationId "com.yoti.mobile.android.sdk.yotidocscan.websample"
         minSdkVersion 21
-        targetSdkVersion 29
+        targetSdkVersion 33
         versionCode 1
         versionName "1.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
 
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+
     buildFeatures {
         viewBinding true
+        buildConfig true
     }
 
     buildTypes {

webapp/src/main/AndroidManifest.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.yoti.mobile.android.sdk.yotidocscan.websample">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.CAMERA" />
@@ -21,6 +20,7 @@
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
         <activity android:name=".MainActivity"
+            android:exported="true"
             android:screenOrientation="portrait">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

webapp/src/main/java/com/yoti/mobile/android/sdk/yotidocscan/websample/MainActivity.kt

@@ -194,8 +194,6 @@ class MainActivity : AppCompatActivity(), SessionConfigurationListener {
             domStorageEnabled = true
             javaScriptCanOpenWindowsAutomatically = true
             mediaPlaybackRequiresUserGesture = false
-            setAppCacheEnabled(true)
-
         }
         this.webViewClient = YdsWebClient()
         this.webChromeClient = YdsWebChromeClient()