@aparajita/capacitor-biometric-auth 5.2.0 → 5.2.1

package/android/src/main/java/com/aparajita/capacitor/biometricauth/BiometricAuthNative.java

@@ -96,6 +96,13 @@ public class BiometricAuthNative extends Plugin {
    */
   @PluginMethod
   public void checkBiometry(PluginCall call) {
+    call.resolve(checkDeviceBiometry());
+  }
+
+  /**
+   * Check the device's availability and type of biometric authentication.
+   */
+  private JSObject checkDeviceBiometry() {
     BiometricManager manager = BiometricManager.from(getContext());
     int biometryResult;
 
@@ -106,14 +113,14 @@ public class BiometricAuthNative extends Plugin {
       biometryResult = manager.canAuthenticate();
     }
 
-    JSObject ret = new JSObject();
-    ret.put(
+    JSObject result = new JSObject();
+    result.put(
       "isAvailable",
       biometryResult == BiometricManager.BIOMETRIC_SUCCESS
     );
 
     biometryTypes = getDeviceBiometryTypes();
-    ret.put("biometryType", biometryTypes.get(0).getType());
+    result.put("biometryType", biometryTypes.get(0).getType());
 
     JSArray returnTypes = new JSArray();
 
@@ -121,7 +128,7 @@ public class BiometricAuthNative extends Plugin {
       returnTypes.put(type.getType());
     }
 
-    ret.put("biometryTypes", returnTypes);
+    result.put("biometryTypes", returnTypes);
 
     String reason = "";
 
@@ -156,13 +163,13 @@ public class BiometricAuthNative extends Plugin {
       errorCode = "biometryNotAvailable";
     }
 
-    ret.put("reason", reason);
-    ret.put("code", errorCode);
-    call.resolve(ret);
+    result.put("reason", reason);
+    result.put("code", errorCode);
+    return result;
   }
 
   private ArrayList<BiometryType> getDeviceBiometryTypes() {
-    ArrayList<BiometryType> types = new ArrayList<BiometryType>();
+    ArrayList<BiometryType> types = new ArrayList<>();
     PackageManager manager = getContext().getPackageManager();
 
     if (manager.hasSystemFeature(PackageManager.FEATURE_FINGERPRINT)) {
@@ -189,6 +196,17 @@ public class BiometricAuthNative extends Plugin {
    */
   @PluginMethod
   public void authenticate(final PluginCall call) {
+    // Make sure biometry is available
+    JSObject checkResult = checkDeviceBiometry();
+
+    if (Boolean.FALSE.equals(checkResult.getBoolean("isAvailable", false))) {
+      call.reject(
+        checkResult.getString("reason", ""),
+        checkResult.getString("code", "")
+      );
+      return;
+    }
+
     // The result of an intent is supposed to have the package name as a prefix
     RESULT_EXTRA_PREFIX = getContext().getPackageName() + ".";
 
@@ -279,23 +297,19 @@ public class BiometricAuthNative extends Plugin {
     );
 
     switch (resultType) {
-      case SUCCESS:
-        call.resolve();
-        break;
-      case FAILURE:
-        // Biometry was successfully presented but was not recognized
-        call.reject(errorMessage, BIOMETRIC_FAILURE);
-        break;
-      case ERROR:
-        // The user cancelled, the system cancelled, or some error occurred.
-        // If the user cancelled, errorMessage is the text of the "negative" button,
-        // which is not especially descriptive.
+      case SUCCESS -> call.resolve();
+      // Biometry was successfully presented but was not recognized
+      case FAILURE -> call.reject(errorMessage, BIOMETRIC_FAILURE);
+      // The user cancelled, the system cancelled, or some error occurred.
+      // If the user cancelled, errorMessage is the text of the "negative" button,
+      // which is not especially descriptive.
+      case ERROR -> {
         if (errorCode == BiometricPrompt.ERROR_NEGATIVE_BUTTON) {
           errorMessage = "Cancel button was pressed";
         }
 
         call.reject(errorMessage, biometryErrorCodeMap.get(errorCode));
-        break;
+      }
     }
   }
 

package/ios/Plugin/Plugin.swift

@@ -22,12 +22,32 @@ public class BiometricAuthNative: CAPPlugin {
     LAError.biometryNotEnrolled.rawValue: "biometryNotEnrolled"
   ]
 
-  var canEvaluatePolicy = true
+  struct CheckDeviceBiometryResult {
+    let isAvailable: Bool
+    let biometryType: LABiometryType.RawValue
+    let biometryTypes: JSArray
+    let reason: String
+    let code: String
+  }
 
   /**
-   * Check the device's availability and type of biometric authentication.
+   * Plugin call checkBiometry()
    */
   @objc func checkBiometry(_ call: CAPPluginCall) {
+    let checkResult = checkDeviceBiometry()
+    call.resolve([
+      "isAvailable": checkResult.isAvailable,
+      "biometryType": checkResult.biometryType,
+      "biometryTypes": checkResult.biometryTypes,
+      "reason": checkResult.reason,
+      "code": checkResult.code
+    ])
+  }
+
+  /**
+   * Check the device's availability and type of biometric authentication.
+   */
+  func checkDeviceBiometry() -> CheckDeviceBiometryResult {
     let context = LAContext()
     var error: NSError?
     var available = context.canEvaluatePolicy(.deviceOwnerAuthenticationWithBiometrics, error: &error)
@@ -42,7 +62,6 @@ public class BiometricAuthNative: CAPPlugin {
 
       if entry == nil {
         available = false
-        canEvaluatePolicy = false
         reason = kMissingFaceIDUsageEntry
         errorCode = biometryErrorCodeMap[LAError.biometryNotAvailable.rawValue] ?? ""
       }
@@ -61,13 +80,13 @@ public class BiometricAuthNative: CAPPlugin {
     var types = JSArray()
     types.append(context.biometryType.rawValue)
 
-    call.resolve([
-      "isAvailable": available,
-      "biometryType": context.biometryType.rawValue,
-      "biometryTypes": types,
-      "reason": reason,
-      "code": errorCode
-    ])
+    return CheckDeviceBiometryResult(
+      isAvailable: available,
+      biometryType: context.biometryType.rawValue,
+      biometryTypes: types,
+      reason: reason,
+      code: errorCode
+    )
   }
 
   /**
@@ -79,9 +98,11 @@ public class BiometricAuthNative: CAPPlugin {
    */
   @objc func authenticate(_ call: CAPPluginCall) {
     // Make sure the app can evaluate policy, otherwise evaluatePolicy() will crash
-    guard canEvaluatePolicy else {
+    let checkResult = checkDeviceBiometry()
+
+    guard checkResult.isAvailable else {
       call.reject(
-        kMissingFaceIDUsageEntry,
+        checkResult.reason,
         biometryErrorCodeMap[LAError.biometryNotAvailable.rawValue]
       )
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aparajita/capacitor-biometric-auth",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "description": "Provides access to the native biometric auth APIs for Capacitor apps",
   "author": "Aparajita Fishman",
   "license": "MIT",
@@ -56,21 +56,21 @@
     "@aparajita/eslint-config-base": "^1.1.6",
     "@aparajita/prettier-config": "^2.0.0",
     "@aparajita/swiftly": "^1.0.4",
-    "@capacitor/cli": "^5.4.1",
+    "@capacitor/cli": "^5.4.2",
     "@commitlint/cli": "^17.7.2",
     "@commitlint/config-conventional": "^17.7.0",
     "@ionic/swiftlint-config": "^1.1.2",
-    "@rollup/plugin-json": "^6.0.0",
-    "@types/node": "^20.8.0",
-    "@typescript-eslint/eslint-plugin": "^6.7.3",
-    "@typescript-eslint/parser": "^6.7.3",
-    "commit-and-tag-version": "^11.2.3",
-    "eslint": "^8.50.0",
+    "@rollup/plugin-json": "^6.0.1",
+    "@types/node": "^20.8.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "commit-and-tag-version": "^11.3.0",
+    "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-n": "^16.1.0",
+    "eslint-plugin-n": "^16.2.0",
     "eslint-plugin-promise": "^6.1.1",
     "nodemon": "^3.0.1",
     "prettier": "^3.0.3",
@@ -81,10 +81,10 @@
     "typescript": "~5.2.2"
   },
   "dependencies": {
-    "@capacitor/android": "^5.4.1",
+    "@capacitor/android": "^5.4.2",
     "@capacitor/app": "^5.0.6",
-    "@capacitor/core": "^5.4.1",
-    "@capacitor/ios": "^5.4.1"
+    "@capacitor/core": "^5.4.2",
+    "@capacitor/ios": "^5.4.2"
   },
   "scripts": {
     "clean": "rimraf dist",