@aparajita/capacitor-biometric-auth 7.1.0 → 7.2.0

package/README.md

@@ -33,11 +33,9 @@ Not using [pnpm](https://pnpm.js.org/)? You owe it to yourself to give it a try.
 
 The API is extensively documented in the [TypeScript definitions file](src/definitions.ts). There is also (somewhat incomplete auto-generated) documentation [below](#api). For a complete example of how to use this plugin in practice, see the [demo app](https://github.com/aparajita/capacitor-biometric-auth-demo).
 
-👉 **NOTE:** Your Android app must use a base theme named "AppTheme".
-
 ### Checking availability
 
-Before giving the user the option to use biometry (such as displaying a biometry icon), call [`checkBiometry()`](#checkbiometry) and inspect the [`CheckBiometryResult`](#checkbiometryresult) to see what (if any) biometry and/or device credentials are available on the device. Note the following:
+Although not strictly necessary, before giving the user the option to use biometry (such as displaying a biometry icon), you will probably want to call [`checkBiometry()`](#checkbiometry) and inspect the [`CheckBiometryResult`](#checkbiometryresult) to see what (if any) biometry and/or device credentials are available on the device. Note the following:
 
 - `isAvailable` may be `false` but `biometryType` may indicate the presence of biometry on the device. This occurs if the current user is not enrolled in biometry, or if biometry has been disabled for the current app. In such cases the `reason` and `code` will tell you why.
 

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

@@ -42,8 +42,10 @@ public class AuthActivity extends AppCompatActivity {
       BiometricManager.Authenticators.BIOMETRIC_WEAK
     );
 
-    allowDeviceCredential =
-      intent.getBooleanExtra(BiometricAuthNative.DEVICE_CREDENTIAL, false);
+    allowDeviceCredential = intent.getBooleanExtra(
+      BiometricAuthNative.DEVICE_CREDENTIAL,
+      false
+    );
 
     // Android docs say that BIOMETRIC_STRONG | DEVICE_CREDENTIAL cannot be used on API 28-29.
     // If that is the case, fall back to BIOMETRIC_WEAK.

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

@@ -7,6 +7,7 @@ import android.content.Context;
 import android.content.Intent;
 import android.content.pm.PackageManager;
 import androidx.activity.result.ActivityResult;
+import androidx.annotation.NonNull;
 import androidx.biometric.BiometricManager;
 import androidx.biometric.BiometricPrompt;
 import com.getcapacitor.JSArray;
@@ -94,13 +95,14 @@ public class BiometricAuthNative extends Plugin {
   private ArrayList<BiometryType> biometryTypes;
 
   private int getAuthenticatorFromCall(PluginCall call) {
+    int authenticator = BiometricManager.Authenticators.BIOMETRIC_WEAK;
+
     Integer value = call.getInt(
       "androidBiometryStrength",
       BiometryStrength.WEAK.ordinal()
     );
-    int authenticator = BiometricManager.Authenticators.BIOMETRIC_WEAK;
 
-    if (value == BiometryStrength.STRONG.ordinal()) {
+    if (value != null && value == BiometryStrength.STRONG.ordinal()) {
       authenticator = BiometricManager.Authenticators.BIOMETRIC_STRONG;
     }
 
@@ -112,6 +114,10 @@ public class BiometricAuthNative extends Plugin {
    */
   @PluginMethod
   public void checkBiometry(PluginCall call) {
+    call.resolve(checkBiometry());
+  }
+
+  private JSObject checkBiometry() {
     JSObject result = new JSObject();
     BiometricManager manager = BiometricManager.from(getContext());
 
@@ -161,7 +167,7 @@ public class BiometricAuthNative extends Plugin {
       result.put("deviceIsSecure", false);
     }
 
-    call.resolve(result);
+    return result;
   }
 
   private static void setReasonAndCode(
@@ -206,6 +212,7 @@ public class BiometricAuthNative extends Plugin {
     result.put(strong ? "strongCode" : "code", errorCode);
   }
 
+  @NonNull
   private ArrayList<BiometryType> getDeviceBiometryTypes() {
     ArrayList<BiometryType> types = new ArrayList<>();
     PackageManager manager = getContext().getPackageManager();
@@ -222,7 +229,7 @@ public class BiometricAuthNative extends Plugin {
       types.add(BiometryType.IRIS);
     }
 
-    if (types.size() == 0) {
+    if (types.isEmpty()) {
       types.add(BiometryType.NONE);
     }
 
@@ -234,16 +241,26 @@ public class BiometricAuthNative extends Plugin {
    */
   @PluginMethod
   public void internalAuthenticate(final PluginCall call) {
+    // If the user has not called checkBiometry() first, we need to get the list
+    // of supported biometry.
+    if (biometryTypes == null) {
+      biometryTypes = getDeviceBiometryTypes();
+    }
+
     // The result of an intent is supposed to have the package name as a prefix.
     RESULT_EXTRA_PREFIX = getContext().getPackageName() + ".";
 
     Intent intent = new Intent(getContext(), AuthActivity.class);
 
     // Pass the options to the activity.
-    intent.putExtra(
-      TITLE,
-      call.getString(TITLE, biometryNameMap.get(biometryTypes.get(0)))
-    );
+    String title = "";
+
+    // If no biometry is available, biometryTypes will be an empty list.
+    if (!biometryTypes.isEmpty()) {
+      title = biometryNameMap.get(biometryTypes.get(0));
+    }
+
+    intent.putExtra(TITLE, call.getString(TITLE, title));
     intent.putExtra(SUBTITLE, call.getString(SUBTITLE));
     intent.putExtra(REASON, call.getString(REASON));
     intent.putExtra(CANCEL_TITLE, call.getString(CANCEL_TITLE));
@@ -290,10 +307,9 @@ public class BiometricAuthNative extends Plugin {
     String resultTypeName = null;
 
     if (data != null) {
-      resultTypeName =
-        data.getStringExtra(
-          RESULT_EXTRA_PREFIX + BiometricAuthNative.RESULT_TYPE
-        );
+      resultTypeName = data.getStringExtra(
+        RESULT_EXTRA_PREFIX + BiometricAuthNative.RESULT_TYPE
+      );
     }
 
     if (resultTypeName == null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aparajita/capacitor-biometric-auth",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "Provides access to the native biometric auth & device security APIs for Capacitor apps",
   "author": "Aparajita Fishman",
   "license": "MIT",
@@ -57,36 +57,36 @@
     "@aparajita/eslint-config-base": "^1.1.6",
     "@aparajita/prettier-config": "^2.0.0",
     "@aparajita/swiftly": "^1.0.4",
-    "@capacitor/cli": "^5.6.0",
-    "@commitlint/cli": "^18.4.4",
-    "@commitlint/config-conventional": "^18.4.4",
+    "@capacitor/cli": "^5.7.4",
+    "@commitlint/cli": "^19.2.1",
+    "@commitlint/config-conventional": "^19.1.0",
     "@ionic/swiftlint-config": "^1.1.2",
     "@rollup/plugin-json": "^6.1.0",
-    "@types/node": "^20.10.8",
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
-    "commit-and-tag-version": "^12.1.0",
-    "eslint": "^8.56.0",
+    "@types/node": "^20.12.4",
+    "@typescript-eslint/eslint-plugin": "^7.5.0",
+    "@typescript-eslint/parser": "^7.5.0",
+    "commit-and-tag-version": "^12.2.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.1.1",
-    "nodemon": "^3.0.2",
-    "prettier": "^3.1.1",
-    "prettier-plugin-java": "^2.5.0",
+    "nodemon": "^3.1.0",
+    "prettier": "^3.2.5",
+    "prettier-plugin-java": "^2.6.0",
     "rimraf": "^5.0.5",
-    "rollup": "^4.9.4",
-    "simple-git-hooks": "^2.9.0",
+    "rollup": "^4.14.0",
+    "simple-git-hooks": "^2.11.1",
     "swiftlint": "^1.0.2",
-    "typescript": "~5.3.3"
+    "typescript": "~5.4.3"
   },
   "dependencies": {
-    "@capacitor/android": "^5.6.0",
-    "@capacitor/app": "^5.0.6",
-    "@capacitor/core": "^5.6.0",
-    "@capacitor/ios": "^5.6.0"
+    "@capacitor/android": "^5.7.4",
+    "@capacitor/app": "^5.0.7",
+    "@capacitor/core": "^5.7.4",
+    "@capacitor/ios": "^5.7.4"
   },
   "scripts": {
     "clean": "rimraf dist",