Release commit for 3.6.0

Jumio · Apr 29, 2020 · 7f6b84f · 7f6b84f
1 parent a4e176d
commit 7f6b84f
Show file tree

Hide file tree

Showing 85 changed files with 6,198 additions and 2,502 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+sample/JumioMobileSDKSample/Build
+sample/JumioMobileSDK
+*/.DS_Store
+.DS_Store
+
+#test
diff --git a/README.md b/README.md
@@ -8,21 +8,21 @@
 - [FAQ](docs/integration_faq.md)
 
 # Release notes
-### SDK version: 3.5.0
+### SDK version: 3.6.0
 
 #### Deprecation notice
-This is the last version that supports Android 4.x and 5.0. The minimum supported Android version will be increased to 5.1 (API level 22) in the next SDK version 3.6.0.
+This is the last version that supports Android 4.x and 5.0. The minimum supported Android version will be increased to 5.1 (API level 22) in the next SDK version 3.7.0.
 
 #### Changes
-* New Singapore datacenter compatibility [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
-* Support for dynamic library modules to reduce the initial download size of the app  [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
-* Advanced document checks on the back of IDs to increase user conversion - for paper documents [Netverify]
-* Aligned confirmation view design with Netverify [Document Verification]
-* Added fallback handling for device cameras without auto-focus [Netverify/Fastfill]
+* Support for 5 new languages (Czech, Greek, Hungarian, Polish, Romanian) [Netverify/Fastfill, Authentication, Document Verification]
+* Added support for right-to-left languages [Netverify/Fastfill, Authentication, Document Verification]
+* Reduced SDK size by ~1.5 MB [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
+* Provide access to document guidance animation [Netverify Custom UI]
+* Advanced custom UI sample implementation [Netverify Custom UI Sample]
+* Adjusted handling of document types which don’t support plastic documents [Netverify]
 
 #### Fixes
-* Fixed handling of credit card masking [BAM checkout]
-* Fixed problems with Belgium ID card backside scanning [Netverify/Fastfill]
+* Improved accessibility handling [Netverify/Fastfill, Authentication, Document Verification]
 * Various smaller bug fixes/improvements [Netverify/Fastfill, Authentication, Document Verification]
 
 
@@ -101,16 +101,23 @@ __Note:__ You get an *UnsatisfiedLinkError*, if the app and the CPU architecture
 Our SDK supports the [default Android localization features](https://developer.android.com/training/basics/supporting-devices/languages.html) for different languages and cultures.
 All label texts and button titles in the SDK can be changed and localized by adding the required Strings you want to change in a `strings.xml` file in a `values` directory for the language and culture preference that you want to support. You can check out strings that are modifiable at [.../src/main/res/values/strings-jumio-sdk.xml](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/res/values/strings-jumio-sdk.xml) within our Sample application.
 
-For our products Netverify & Fastfill, Authentication & Document Verification we are providing eight individual languages for your convenience:
+For our products Netverify & Fastfill, Authentication & Document Verification we support following languages for your convenience:
 * Chinese (Simplified)
+* Czech
 * Dutch
 * English
 * French
 * German
+* Greek
+* Hungarian
 * Italian
+* Polish
 * Portuguese
+* Romanian
 * Spanish
 
+
+
 Our SDK supports accessibility features. Visually impaired users can now enable __TalkBack__ or change the __font size__ on their device. The accessibility-strings that are used by TalkBack contain *accessibility_* in their key and can be also modified in the `strings.xml`.
 
 # Get started
@@ -122,7 +129,7 @@ Our SDK supports accessibility features. Visually impaired users can now enable
 # Support
 
 ## Previous version
-The previous release version 3.4.1 of the Jumio Mobile SDK is supported until 2020-05-01.
+The previous release version 3.5.0 of the Jumio Mobile SDK is supported until 2020-08-04.
 
 In case the support period is expired, no bug fixes and technical support are provided anymore (bugs are typically fixed in the upcoming versions).
 Older SDK versions will keep functioning with our server until further notice, but we highly recommend to always update to the latest version to benefit from SDK improvements and bug fixes.

diff --git a/docs/images/custom_ui_happy_path_diagram.jpg b/docs/images/custom_ui_happy_path_diagram.jpg
diff --git a/docs/integration_authentication.md b/docs/integration_authentication.md
@@ -15,7 +15,7 @@ Biometric-based Jumio Authentication establishes the digital identities of your
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_authentication.md) SDK version: 3.5.0
+For technical changes, please read our [transition guide](transition-guide_authentication.md) SDK version: 3.6.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Authentication.
@@ -35,18 +35,17 @@ You can specify your own theme (see chapter [Customization](#customization)). Th
 
 ## Dependencies
 
-The [Sample app](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/) apk size with the products Netverify, BAM, Document Verification and Authentication included is currently __27.43 MB__.
-
 |Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | ---------------------------- |:-------------:|:-----------------|:---------:|
-|com.jumio.android:core:3.5.0@aar                    | x | Jumio Core library		                      | 4.11 MB |
-|com.jumio.android:auth:3.5.0@aar                      | x | Authentication library 		              | 93.67 KB |
-|com.jumio.android:face:3.5.0@aar                     | x | Face library	                            | 95.43 KB |
+|com.jumio.android:core:3.6.0@aar                    | x | Jumio Core library		                      | 4.09 MB |
+|com.jumio.android:auth:3.6.0@aar                      | x | Authentication library 		              | 97.98 KB |
+|com.jumio.android:face:3.6.0@aar                     | x | Face library	                            | 100.56 KB |
 |com.facetec:zoom-authentication:8.0.11@aar     | x | Zoom face scanning library	              | 9.00 MB  |
 |androidx.appcompat:appcompat:1.1.0                   | x | Android appcompat library	                | - |
 |androidx.room:room-runtime:2.2.3                     | x | Android database object mapping library	  | - |
-|com.google.android.material:material:1.0.0           | x | Android material design library	          | - |
-|com.jumio.android:javadoc:3.5.0                     |   | Jumio SDK Javadoc			                    | - |
+|com.google.android.material:material:1.1.0           | x | Android material design library	          | - |
+|androidx.localbroadcastmanager:localbroadcastmanager:1.0.0 | x | Android local broadcast manager library | - |
+|com.jumio.android:javadoc:3.6.0                     |   | Jumio SDK Javadoc			                    | - |
 
 ### Others
 
@@ -235,7 +234,7 @@ Using width as match_parent, the AuthenticationCustomScanView attribute ratio ne
 xmlns:yourNameSpace="http://schemas.android.com/apk/lib/com.jumio.mobile.sdk"
 ```
 
-`onAuthenticationUserConsentRequried` within *yourAuthenticationCustomSDKInterface* is invoked when the end-user’s consent to Jumio’s privacy policy is legally required. [onUserConsented](https://jumio.github.io/mobile-sdk-android/com/jumio/auth/custom/AuthenticationCustomSDKController.html#onUserConsented--) needs to be called after the end-user has accepted 
+`onAuthenticationUserConsentRequried` within *yourAuthenticationCustomSDKInterface* is invoked when the end-user’s consent to Jumio’s privacy policy is legally required. [onUserConsented](https://jumio.github.io/mobile-sdk-android/com/jumio/auth/custom/AuthenticationCustomSDKController.html#onUserConsented--) needs to be called after the end-user has accepted
 
 Start scanning by providing an instance of the class `AuthenticationCustomScanView` and an instance of your class which implements the [AuthenticationCustomScanInterface](https://jumio.github.io/mobile-sdk-android/com/jumio/auth/custom/AuthenticationCustomScanInterface.html).
 

diff --git a/docs/integration_bam-checkout.md b/docs/integration_bam-checkout.md
@@ -17,7 +17,7 @@ BAM Checkout SDK is a powerful, cutting-edge solution to extract data from your
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 3.5.0
+For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 3.6.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Bam-Checkout.
@@ -42,11 +42,13 @@ If you want to use offline scanning for BAM Checkout (Credit card scanning), ple
 
 |Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | :---------------------------- |:-------------:|:-----------------|:------------:|
-|com.jumio.android:core:3.5.0@aar                    | x | Jumio Core library|	4.11 MB |
-|com.jumio.android:bam:3.5.0@aar                     | x | BAM Checkout library | 3.62 MB |
+|com.jumio.android:core:3.6.0@aar                    | x | Jumio Core library|	4.09 MB |
+|com.jumio.android:bam:3.6.0@aar                     | x | BAM Checkout library | 3.63 MB |
 |androidx.appcompat:appcompat:1.1.0            				| x | Android appcompat library| - |
 |androidx.room:room-runtime:2.2.3			              | x | Android database object mapping library	| - |
-|com.jumio.android:javadoc:3.5.0                     |   | Jumio SDK Javadoc| - |
+|com.google.android.material:material:1.1.0           | x | Android material design library	          | - |
+|androidx.localbroadcastmanager:localbroadcastmanager:1.0.0 | x | Android local broadcast manager library  | - |
+|com.jumio.android:javadoc:3.6.0                     |   | Jumio SDK Javadoc| - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 

diff --git a/docs/integration_document-verification.md b/docs/integration_document-verification.md
@@ -15,7 +15,7 @@ Document Verification is a powerful solution to enable scanning various types (U
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_document-verification.md) SDK version: 3.5.0
+For technical changes, please read our [transition guide](transition-guide_document-verification.md) SDK version: 3.6.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for DocumentVerification.
@@ -39,11 +39,13 @@ You can specify your own theme (see [Customization](#customizing-look-and-feel)
 
 | Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | ----------------- |:-------------------:|:------------------|:-------------------:|
-| com.jumio.android:core:3.5.0@aar                    | x | Jumio Core library            | 4.11 MB |
-| com.jumio.android:dv:3.5.0@aar                      | x | Document Verification library | 125.75 KB |
+| com.jumio.android:core:3.6.0@aar                    | x | Jumio Core library            | 4.09 MB |
+| com.jumio.android:dv:3.6.0@aar                      | x | Document Verification library | 134.70 KB |
 | androidx.appcompat:appcompat:1.1.0                   | x | Android appcompat library        | - |
+|com.google.android.material:material:1.1.0           | x | Android material design library	          | - |
+|androidx.localbroadcastmanager:localbroadcastmanager:1.0.0 | x | Android local broadcast manager library  	| - |
 |androidx.room:room-runtime:2.2.3			              | x | Android database object mapping library	| - |
-| com.jumio.android:javadoc:3.5.0                     |   | Jumio SDK Javadoc             | - |
+| com.jumio.android:javadoc:3.6.0                     |   | Jumio SDK Javadoc             | - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 

diff --git a/docs/integration_faq.md b/docs/integration_faq.md
@@ -19,7 +19,7 @@ One pattern that is recognizable throughout all of our customers’ SDK implemen
 
 Our SDK provides a variety of customization options to help customers achieve a seamless integration. For customers using the standard SDK workflow, our [Surface tool](https://jumio.github.io/surface-android/) provides an easy-to-use WYSIWYG interface to see simple customization options that can be incorporated with minimal effort and generate the code necessary to implement them. For customers who want to have more granular control over look and feel, our SDK offers the [CustomUI](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_netverify-fastfill.md#custom-ui) option, which allows you to customize the entire user interface.
 
-#### Example case:
+#### Example of a non ideal SDK integration:
 ![Onboarding bad case](images/onboardingBadCase.jpg)
 - Default SDK UI is used and is presented on one of the first screens during onboarding. The user is unprepared for the next steps and might not understand the intention behind the request to show their ID.
 
@@ -43,20 +43,24 @@ The following table highlights the most common error codes which are returned fr
 
 ### Reducing the size of your app
 The Netverify SDK contains a wide range of different scanning methods. The SDK is able to capture identity documents and extract information on the device using enhanced machine learning and computer vision technologies.
-The current download size of the sample application containing all products is 29 MB as mentioned in the [Netverify guide](integration_netverify-fastfill.md).
+The current download size of the sample application containing all products is around **18 MB** as mentioned in the [Netverify guide](integration_netverify-fastfill.md).
 If you want to reduce the size of the SDK within your application, there are several ways that are explained in the following chapters.
 
 #### Strip unused modules
-Depending on the functionality you require, you may want to strip out unused functionality. This can be done adapting your jumio dependencies in your build.gradle. The following table shows a range of different product configurations with the size and modules that are linked for it. The measurements are based on our sample application.
+Depending on the functionality you require, you may want to strip out unused functionality. This can be done adapting your jumio dependencies in your build.gradle. The following table shows a range of different product configurations with the size and modules that are linked for it.
+The measurements reflect the extra size that Jumio components add to your app download size.
+The sizes are calculated based on a build of our sample application using arm64 architecture, english translations and xxhdpi screen resolution
 
 |Product Configuration      | Size   | Modules   |
 |:--------------------------|:------:|:----------|
-|Full Netverify + Authentication                       | 23.7 MB    | core, nv, nv-mrz, nv-ocr, nv-nfc, nv-barcode, auth, face |
-|Netverify MRZ only with Face                          | 20.08 MB  | core, nv, nv-mrz, face |
-|Netverify MRZ only without Face                       | 9.24 MB   | core, nv, nv-mrz |
-|Netverify Barcode scanning without Face               | 7.9 MB   | core, nv, nv-barcode-vision |
-|BAM Checkout                                          | 11.36 MB   | core, bam |
-|Document verification                                 | 7.9 MB   | core, dv  |
+|Netverify + Authentication                            | 13.6 MB    | core, nv, nv-mrz, nv-ocr, nv-nfc, nv-barcode, auth, face, zoom-authentication |
+|Netverify w/o NFC                                     | 12.6 MB    | core, nv, nv-mrz, nv-ocr, nv-barcode, face, zoom-authentication |
+|Netverify w/o 3D liveness                             | 7.6 MB  | core, nv, nv-mrz, nv-ocr, nv-nfc, nv-barcode |
+|Netverify w/o 3D liveness, Barcode                    | 6.5 MB   | core, nv, nv-mrz, nv-ocr |
+|Netverify w/o 3D liveness, Barcode, OCR               | 6.0 MB   | core, nv, nv-mrz |
+|Netverify minimum                                     | 2.5 MB   | core, nv |
+|BAM Checkout                                          | 4.9 MB   | core, bam |
+|Document verification                                 | 2.3 MB   | core, dv  |
 
 
 #### App bundles