@regulaforensics/cordova-plugin-document-reader-api 6.4.0 → 6.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/cordova-plugin-document-reader-api",
-  "version": "6.4.0",
+  "version": "6.6.0",
   "description": "Cordova plugin for reading and validation of identification documents (API framework)",
   "cordova": {
     "id": "@regulaforensics/cordova-plugin-document-reader-api",

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="cordova-plugin-document-reader-api" version="6.4.0"
+<plugin id="cordova-plugin-document-reader-api" version="6.6.0"
   xmlns="http://apache.org/cordova/ns/plugins/1.0">
   <name>DocumentReaderApi</name>
   <description>Cordova plugin Document reader api</description>
@@ -23,9 +23,10 @@
     <header-file src="src/ios/RegulaConfig.h" />
     <source-file src="src/ios/RegulaConfig.m" />
     <podspec>
-      <config/>
+        <config>
+        </config>
       <pods>
-        <pod name="DocumentReader" spec="~> 6.4.2552" />
+        <pod name="DocumentReader" spec="~> 6.6.2753" />
       </pods>
     </podspec>
   </platform>
@@ -41,5 +42,6 @@
     <source-file src="src/android/JSONConstructor.java" target-dir="src/cordova.plugin.documentreader" />
     <source-file src="src/android/RegulaConfig.java" target-dir="src/cordova.plugin.documentreader" />
     <source-file src="src/android/Helpers.java" target-dir="src/cordova.plugin.documentreader" />
+    <source-file src="src/android/BluetoothUtil.kt" target-dir="java/cordova.plugin.documentreader" />
   </platform>
 </plugin>

package/src/android/BluetoothUtil.kt

@@ -0,0 +1,108 @@
+package cordova.plugin.documentreader
+
+import android.Manifest.permission.*
+import android.annotation.SuppressLint
+import android.app.Activity
+import android.bluetooth.BluetoothAdapter
+import android.content.ComponentName
+import android.content.Intent
+import android.content.ServiceConnection
+import android.content.pm.PackageManager.PERMISSION_GRANTED
+import android.os.Build
+import android.os.IBinder
+import android.provider.Settings
+import androidx.annotation.RequiresPermission
+import androidx.core.app.ActivityCompat.requestPermissions
+import androidx.core.content.ContextCompat.checkSelfPermission
+import com.regula.documentreader.api.ble.BLEWrapper
+import com.regula.documentreader.api.ble.BleWrapperCallback
+import com.regula.documentreader.api.ble.RegulaBleService
+import com.regula.documentreader.api.internal.permission.BluetoothPermissionHelper.BLE_ACCESS_PERMISSION
+import com.regula.documentreader.api.internal.permission.BluetoothSettingsHelper.isBluetoothEnabled
+import com.regula.documentreader.api.internal.permission.BluetoothSettingsHelper.isLocationServiceEnabled
+
+class BluetoothUtil {
+    companion object {
+        private const val REQUEST_ENABLE_LOCATION = 196
+        private const val REQUEST_ENABLE_BT = 197
+
+        @SuppressLint("StaticFieldLeak")
+        var bleManager: BLEWrapper? = null
+
+        @RequiresPermission("android.permission.BLUETOOTH_CONNECT")
+        private fun requestEnableBle(activity: Activity) {
+            val enableIntent = Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE)
+            activity.startActivityForResult(enableIntent, REQUEST_ENABLE_BT)
+        }
+
+        private fun requestEnableLocationService(activity: Activity) {
+            val myIntent = Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS)
+            activity.startActivityForResult(myIntent, REQUEST_ENABLE_LOCATION)
+        }
+
+        // requestEnableBle() is called after a check for permission
+        @SuppressLint("MissingPermission")
+        fun isBlePermissionsGranted(activity: Activity): Boolean {
+            if (!isLocationServiceEnabled(activity)) {
+                requestEnableLocationService(activity)
+                return false
+            }
+            deniedBluetoothPermissions(activity)?.let {
+                requestPermissions(activity, it, BLE_ACCESS_PERMISSION)
+                return false
+            }
+            if (!isBluetoothEnabled(activity)) {
+                requestEnableBle(activity)
+                return false
+            }
+            return true
+        }
+
+        private fun deniedBluetoothPermissions(activity: Activity): Array<String>? {
+            val result = mutableListOf<String>()
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+                result.addAll(deniedBluetoothPermission(activity, BLUETOOTH_SCAN))
+                result.addAll(deniedBluetoothPermission(activity, BLUETOOTH_CONNECT))
+            } else
+                result.addAll(deniedBluetoothPermission(activity, ACCESS_FINE_LOCATION))
+            return result.let { if (it.size > 0) it.toTypedArray() else null }
+        }
+
+        private fun deniedBluetoothPermission(
+                activity: Activity,
+                permission: String
+        ): Array<String> {
+            if (checkSelfPermission(activity, permission) != PERMISSION_GRANTED)
+                return arrayOf(permission)
+            return arrayOf()
+        }
+
+        fun startBluetoothService(
+                activity: Activity,
+                onConnected: (Boolean) -> Unit,
+                onDisconnected: () -> Unit,
+                onReady: () -> Unit,
+        ) {
+            val bleIntent = Intent(activity, RegulaBleService::class.java)
+            activity.startService(bleIntent)
+
+            activity.bindService(bleIntent, object : ServiceConnection {
+                override fun onServiceConnected(name: ComponentName, service: IBinder) {
+                    bleManager = (service as RegulaBleService.LocalBinder).service.bleManager
+                    val isBleManagerConnected = bleManager?.isConnected == true
+                    onConnected(isBleManagerConnected)
+                    if (!isBleManagerConnected) {
+                        bleManager?.addCallback(object : BleWrapperCallback() {
+                            override fun onDeviceReady() {
+                                bleManager!!.removeCallback(this)
+                                onReady()
+                            }
+                        })
+                    }
+                }
+
+                override fun onServiceDisconnected(name: ComponentName) = onDisconnected()
+            }, 0)
+        }
+    }
+}

package/src/android/DocumentReader.java

@@ -9,10 +9,12 @@ import android.content.IntentFilter;
 import android.graphics.Bitmap;
 import android.nfc.NfcAdapter;
 import android.nfc.tech.IsoDep;
-import androidx.annotation.NonNull;
 import android.os.Bundle;
 import android.util.Base64;
 
+import androidx.annotation.NonNull;
+
+import com.regula.documentreader.api.completions.ICheckDatabaseUpdate;
 import com.regula.documentreader.api.completions.IDocumentReaderCompletion;
 import com.regula.documentreader.api.completions.IDocumentReaderInitCompletion;
 import com.regula.documentreader.api.completions.IDocumentReaderPrepareCompletion;
@@ -23,14 +25,15 @@ import com.regula.documentreader.api.completions.ITccParamsCompletion;
 import com.regula.documentreader.api.enums.DocReaderAction;
 import com.regula.documentreader.api.errors.DocumentReaderException;
 import com.regula.documentreader.api.internal.core.CoreScenarioUtil;
+import com.regula.documentreader.api.params.BleDeviceConfig;
 import com.regula.documentreader.api.params.DocReaderConfig;
 import com.regula.documentreader.api.params.ImageInputData;
-import com.regula.documentreader.api.params.ImageInputParam;
+import com.regula.documentreader.api.internal.params.ImageInputParam;
 import com.regula.documentreader.api.params.rfid.PKDCertificate;
 import com.regula.documentreader.api.params.rfid.authorization.PAResourcesIssuer;
 import com.regula.documentreader.api.params.rfid.authorization.TAChallenge;
 import com.regula.documentreader.api.results.DocumentReaderResults;
-import com.regula.documentreader.api.parser.DocReaderResultsJsonParser;
+import com.regula.documentreader.api.internal.parser.DocReaderResultsJsonParser;
 
 import org.apache.cordova.CallbackContext;
 import org.apache.cordova.CordovaPlugin;
@@ -57,9 +60,15 @@ public class DocumentReader extends CordovaPlugin {
     private IRfidPKDCertificateCompletion taCertificateCompletion;
     private IRfidTASignatureCompletion taSignatureCompletion;
     private final static String rfidNotificationCompletionEvent = "rfidNotificationCompletionEvent";
+
     private final static String paCertificateCompletionEvent = "paCertificateCompletionEvent";
     private final static String taCertificateCompletionEvent = "taCertificateCompletionEvent";
     private final static String taSignatureCompletionEvent = "taSignatureCompletionEvent";
+
+    private final static String bleOnServiceConnectedEvent = "bleOnServiceConnectedEvent";
+    private final static String bleOnServiceDisconnectedEvent = "bleOnServiceDisconnectedEvent";
+    private final static String bleOnDeviceReadyEvent = "bleOnDeviceReadyEvent";
+
     private static int databaseDownloadProgress = 0;
 
     private Context getContext() {
@@ -118,13 +127,13 @@ public class DocumentReader extends CordovaPlugin {
     }
 
     private void sendIRfidNotificationCompletion(int notification, Bundle value) {
-        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, rfidNotificationCompletionEvent + JSONConstructor.generateRfidNotificationCompletion(notification, value).toString());
+        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, rfidNotificationCompletionEvent + JSONConstructor.generateRfidNotificationCompletion(notification, value));
         pluginResult.setKeepCallback(true);
         callbackContext.sendPluginResult(pluginResult);
     }
 
     private void sendPACertificateCompletion(byte[] serialNumber, PAResourcesIssuer issuer) {
-        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, paCertificateCompletionEvent + JSONConstructor.generatePACertificateCompletion(serialNumber, issuer).toString());
+        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, paCertificateCompletionEvent + JSONConstructor.generatePACertificateCompletion(serialNumber, issuer));
         pluginResult.setKeepCallback(true);
         callbackContext.sendPluginResult(pluginResult);
     }
@@ -135,7 +144,23 @@ public class DocumentReader extends CordovaPlugin {
         callbackContext.sendPluginResult(pluginResult);
     }
     private void sendTASignatureCompletion(TAChallenge challenge) {
-        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, taSignatureCompletionEvent + JSONConstructor.generateTAChallenge(challenge).toString());
+        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, taSignatureCompletionEvent + JSONConstructor.generateTAChallenge(challenge));
+        pluginResult.setKeepCallback(true);
+        callbackContext.sendPluginResult(pluginResult);
+    }
+    private void sendBleOnServiceConnectedEvent(boolean isBleManagerConnected) {
+        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, bleOnServiceConnectedEvent + isBleManagerConnected);
+        pluginResult.setKeepCallback(true);
+        callbackContext.sendPluginResult(pluginResult);
+    }
+
+    private void sendBleOnServiceDisconnectedEvent() {
+        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, bleOnServiceDisconnectedEvent);
+        pluginResult.setKeepCallback(true);
+        callbackContext.sendPluginResult(pluginResult);
+    }
+    private void sendBleOnDeviceReadyEvent() {
+        PluginResult pluginResult = new PluginResult(PluginResult.Status.OK, bleOnDeviceReadyEvent);
         pluginResult.setKeepCallback(true);
         callbackContext.sendPluginResult(pluginResult);
     }
@@ -168,6 +193,18 @@ public class DocumentReader extends CordovaPlugin {
                 case "initializeReaderAutomatically":
                     initializeReaderAutomatically(callback);
                     break;
+                case "isBlePermissionsGranted":
+                    isBlePermissionsGranted(callback);
+                    break;
+                case "startBluetoothService":
+                    startBluetoothService(callback);
+                    break;
+                case "initializeReaderBleDeviceConfig":
+                    initializeReaderBleDeviceConfig(callback);
+                    break;
+                case "getTag":
+                    getTag(callback);
+                    break;
                 case "getAPIVersion":
                     getAPIVersion(callback);
                     break;
@@ -288,6 +325,12 @@ public class DocumentReader extends CordovaPlugin {
                 case "setCameraSessionIsPaused":
                     setCameraSessionIsPaused(callback, args(0));
                     break;
+                case "setTag":
+                    setTag(callback, args(0));
+                    break;
+                case "checkDatabaseUpdate":
+                    checkDatabaseUpdate(callback, args(0));
+                    break;
                 case "getScenario":
                     getScenario(callback, args(0));
                     break;
@@ -315,6 +358,9 @@ public class DocumentReader extends CordovaPlugin {
                 case "recognizeImage":
                     recognizeImage(callback, args(0));
                     break;
+                case "recognizeData":
+                    recognizeData(callback, args(0));
+                    break;
                 case "setRfidSessionStatus":
                     setRfidSessionStatus(callback, args(0));
                     break;
@@ -333,9 +379,6 @@ public class DocumentReader extends CordovaPlugin {
                 case "setTCCParams":
                     setTCCParams(callback, args(0));
                     break;
-                case "initializeReaderWithDatabase":
-                    initializeReaderWithDatabase(callback, args(0), args(1));
-                    break;
                 case "recognizeImageWithOpts":
                     recognizeImageWithOpts(callback, args(0), args(1));
                     break;
@@ -352,7 +395,8 @@ public class DocumentReader extends CordovaPlugin {
                     recognizeImagesWithImageInputs(callback, args(0));
                     break;
             }
-        } catch (Exception ignored) {
+        } catch (Exception e) {
+            e.printStackTrace();
         }
         return true;
     }
@@ -396,6 +440,37 @@ public class DocumentReader extends CordovaPlugin {
             callback.success("already initialized");
     }
 
+    private void isBlePermissionsGranted(Callback callback) {
+        callback.success(BluetoothUtil.Companion.isBlePermissionsGranted(getActivity()));
+    }
+
+    private void startBluetoothService(Callback callback) {
+        BluetoothUtil.Companion.startBluetoothService(
+                getActivity(),
+                isBleManagerConnected -> {
+                    sendBleOnServiceConnectedEvent(isBleManagerConnected);
+                    return null;
+                },
+                () -> {
+                    sendBleOnServiceDisconnectedEvent();
+                    return null;
+                },
+                () -> {
+                    sendBleOnDeviceReadyEvent();
+                    return null;
+                }
+        );
+        callback.success();
+    }
+
+    private void initializeReaderBleDeviceConfig(Callback callback) {
+        if (BluetoothUtil.Companion.getBleManager() == null) callback.error("bleManager is null");
+        if (!Instance().isReady())
+            Instance().initializeReader(getContext(), new BleDeviceConfig(BluetoothUtil.Companion.getBleManager()), getInitCompletion(callback));
+        else
+            callback.success("already initialized");
+    }
+
     private void getAvailableScenarios(Callback callback) throws JSONException {
         callback.success(JSONConstructor.generateList(Instance().availableScenarios, JSONConstructor::generateDocumentReaderScenario).toString());
     }
@@ -500,16 +575,9 @@ public class DocumentReader extends CordovaPlugin {
         callback.success(Instance().isRFIDAvailableForUse());
     }
 
-    private void initializeReader(Callback callback, Object license) {
+    private void initializeReader(Callback callback, JSONObject config) {
         if (!Instance().isReady())
-            Instance().initializeReader(getContext(), new DocReaderConfig(Base64.decode(license.toString(), Base64.DEFAULT)), getInitCompletion(callback));
-        else
-            callback.success("already initialized");
-    }
-
-    private void initializeReaderWithDatabase(Callback callback, Object license, Object db) {
-        if (!Instance().isReady())
-            Instance().initializeReader(getContext(), new DocReaderConfig(Base64.decode(license.toString(), Base64.DEFAULT), Base64.decode(db.toString(), Base64.DEFAULT)), getInitCompletion(callback));
+            Instance().initializeReader(getContext(), JSONConstructor.DocReaderConfigFromJSON(config), getInitCompletion(callback));
         else
             callback.success("already initialized");
     }
@@ -519,6 +587,20 @@ public class DocumentReader extends CordovaPlugin {
         callback.success();
     }
 
+    private void getTag(Callback callback) {
+        callback.success(Instance().tag);
+    }
+
+    private void setTag(Callback callback, String tag) {
+        Instance().tag = tag;
+        callback.success();
+    }
+
+    private void checkDatabaseUpdate(Callback callback, String databaseId) {
+        Instance().checkDatabaseUpdate(getContext(), databaseId, getCheckDatabaseUpdateCompletion(callback));
+        callback.success();
+    }
+
     private void startNewPage(Callback callback) {
         Instance().startNewPage();
         callback.success();
@@ -534,6 +616,11 @@ public class DocumentReader extends CordovaPlugin {
         Instance().recognizeImage(Helpers.bitmapFromBase64(base64Image), getCompletion());
     }
 
+    private void recognizeData(@SuppressWarnings("unused") Callback callback, Object data) {
+        stopBackgroundRFID();
+        Instance().recognizeImage(Base64.decode(data.toString(), Base64.DEFAULT), getCompletion());
+    }
+
     private void recognizeImages(@SuppressWarnings("unused") Callback callback, JSONArray base64Images) throws JSONException {
         stopBackgroundRFID();
         Bitmap[] images = new Bitmap[base64Images.length()];
@@ -555,7 +642,7 @@ public class DocumentReader extends CordovaPlugin {
     }
 
     private void cancelDBUpdate(Callback callback) {
-        callback.success(Instance().cancelDBUpdate());
+        callback.success(Instance().cancelDBUpdate(getContext()));
     }
 
     private void resetConfiguration(Callback callback) {
@@ -701,7 +788,7 @@ public class DocumentReader extends CordovaPlugin {
         callback.error("getCameraSessionIsPaused() is an ios-only method");
     }
 
-    private void stopRFIDReaderWithErrorMessage(Callback callback, String message) {
+    private void stopRFIDReaderWithErrorMessage(Callback callback, @SuppressWarnings("unused") String message) {
         callback.error("stopRFIDReaderWithErrorMessage() is an ios-only method");
     }
 
@@ -757,6 +844,10 @@ public class DocumentReader extends CordovaPlugin {
         };
     }
 
+    private ICheckDatabaseUpdate getCheckDatabaseUpdateCompletion(Callback callback) {
+        return (database) -> callback.success(JSONConstructor.generateDocReaderDocumentsDatabase(database));
+    }
+
     private ITccParamsCompletion getTCCParamsCompletion(Callback callback) {
         return (success, error) -> {
             if (success)

package/src/android/Helpers.java

@@ -10,7 +10,7 @@ import android.graphics.drawable.Drawable;
 import android.util.Base64;
 
 import com.regula.documentreader.api.enums.BarcodeType;
-import com.regula.documentreader.api.params.FaceMetaData;
+import com.regula.documentreader.api.internal.params.FaceMetaData;
 import com.regula.documentreader.api.results.Bounds;
 
 import org.json.JSONArray;
@@ -31,13 +31,12 @@ class Helpers {
         return result;
     }
 
-    static BitmapDrawable drawableFromBase64(String base64, Context context)
-    {
+    static BitmapDrawable drawableFromBase64(String base64, Context context) {
         byte[] decodedByte = Base64.decode(base64, 0);
-        Bitmap bitmap =  BitmapFactory.decodeByteArray(decodedByte, 0, decodedByte.length);
+        Bitmap bitmap = BitmapFactory.decodeByteArray(decodedByte, 0, decodedByte.length);
         float density = context.getResources().getDisplayMetrics().density;
-        int width = (int)(bitmap.getWidth()*density);
-        int height = (int)(bitmap.getHeight()*density);
+        int width = (int) (bitmap.getWidth() * density);
+        int height = (int) (bitmap.getHeight() * density);
         return new BitmapDrawable(context.getResources(), Bitmap.createScaledBitmap(bitmap, width, height, false));
     }