@capgo/capacitor-native-biometric 5.0.1 → 5.1.1

package/android/src/main/java/ee/forgr/biometric/NativeBiometric.java

@@ -1,5 +1,6 @@
 package ee.forgr.biometric;
 
+import android.annotation.SuppressLint;
 import android.app.Activity;
 import android.app.KeyguardManager;
 import android.content.Context;
@@ -10,6 +11,7 @@ import android.os.Build;
 import android.security.KeyPairGeneratorSpec;
 import android.security.keystore.KeyGenParameterSpec;
 import android.security.keystore.KeyProperties;
+import android.security.keystore.StrongBoxUnavailableException;
 import android.util.Base64;
 import androidx.activity.result.ActivityResult;
 import androidx.biometric.BiometricManager;
@@ -46,7 +48,6 @@ import javax.crypto.spec.SecretKeySpec;
 @CapacitorPlugin(name = "NativeBiometric")
 public class NativeBiometric extends Plugin {
 
-  private BiometricManager biometricManager;
   //protected final static int AUTH_CODE = 0102;
 
   private static final int NONE = 0;
@@ -111,17 +112,33 @@ public class NativeBiometric extends Plugin {
   public void isAvailable(PluginCall call) {
     JSObject ret = new JSObject();
 
-    biometricManager = BiometricManager.from(getContext());
+    boolean useFallback = Boolean.TRUE.equals(
+      call.getBoolean("useFallback", false)
+    );
+
+    BiometricManager biometricManager = BiometricManager.from(getContext());
     int canAuthenticateResult = biometricManager.canAuthenticate();
+    // Using deviceHasCredentials instead of canAuthenticate(DEVICE_CREDENTIAL)
+    // > "Developers that wish to check for the presence of a PIN, pattern, or password on these versions should instead use isDeviceSecure."
+    // @see https://developer.android.com/reference/androidx/biometric/BiometricManager#canAuthenticate(int)
+    boolean fallbackAvailable = useFallback && this.deviceHasCredentials();
+    if (useFallback && !fallbackAvailable) {
+      canAuthenticateResult = BiometricManager.BIOMETRIC_ERROR_HW_UNAVAILABLE;
+    }
+
+    boolean isAvailable =
+      (
+        canAuthenticateResult == BiometricManager.BIOMETRIC_SUCCESS ||
+        fallbackAvailable
+      );
+    ret.put("isAvailable", isAvailable);
 
-    switch (canAuthenticateResult) {
-      case BiometricManager.BIOMETRIC_SUCCESS:
-        ret.put("isAvailable", true);
-        break;
-      default:
-        ret.put("isAvailable", false);
-        ret.put("errorCode", canAuthenticateResult);
-        break;
+    if (!isAvailable) {
+      // BiometricManager Error Constants use the same values as BiometricPrompt's Constants. So we can reuse our
+      int pluginErrorCode = AuthActivity.convertToPluginErrorCode(
+        canAuthenticateResult
+      );
+      ret.put("errorCode", pluginErrorCode);
     }
 
     ret.put("biometryType", getAvailableFeature());
@@ -134,32 +151,30 @@ public class NativeBiometric extends Plugin {
 
     intent.putExtra("title", call.getString("title", "Authenticate"));
 
-    if (call.hasOption("subtitle")) intent.putExtra(
-      "subtitle",
-      call.getString("subtitle")
-    );
-
-    if (call.hasOption("description")) intent.putExtra(
-      "description",
-      call.getString("description")
-    );
+    if (call.hasOption("subtitle")) {
+      intent.putExtra("subtitle", call.getString("subtitle"));
+    }
 
-    if (call.hasOption("negativeButtonText")) intent.putExtra(
-      "negativeButtonText",
-      call.getString("negativeButtonText")
-    );
+    if (call.hasOption("description")) {
+      intent.putExtra("description", call.getString("description"));
+    }
 
-    if (call.hasOption("maxAttempts")) intent.putExtra(
-      "maxAttempts",
-      call.getInt("maxAttempts")
-    );
+    if (call.hasOption("negativeButtonText")) {
+      intent.putExtra(
+        "negativeButtonText",
+        call.getString("negativeButtonText")
+      );
+    }
 
-    boolean useFallback = call.getBoolean("useFallback", false);
+    if (call.hasOption("maxAttempts")) {
+      intent.putExtra("maxAttempts", call.getInt("maxAttempts"));
+    }
 
-    if (useFallback && Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
-      KeyguardManager keyguardManager = (KeyguardManager) getActivity()
-        .getSystemService(Context.KEYGUARD_SERVICE);
-      useFallback = keyguardManager.isDeviceSecure();
+    boolean useFallback = Boolean.TRUE.equals(
+      call.getBoolean("useFallback", false)
+    );
+    if (useFallback) {
+      useFallback = this.deviceHasCredentials();
     }
 
     intent.putExtra("useFallback", useFallback);
@@ -181,14 +196,17 @@ public class NativeBiometric extends Plugin {
             Context.MODE_PRIVATE
           )
           .edit();
-        editor.putString("username", encryptString(username, KEY_ALIAS));
-        editor.putString("password", encryptString(password, KEY_ALIAS));
+        editor.putString(
+          KEY_ALIAS + "-username",
+          encryptString(username, KEY_ALIAS)
+        );
+        editor.putString(
+          KEY_ALIAS + "-password",
+          encryptString(password, KEY_ALIAS)
+        );
         editor.apply();
         call.resolve();
-      } catch (GeneralSecurityException e) {
-        call.reject("Failed to save credentials", e);
-        e.printStackTrace();
-      } catch (IOException e) {
+      } catch (GeneralSecurityException | IOException e) {
         call.reject("Failed to save credentials", e);
         e.printStackTrace();
       }
@@ -206,8 +224,14 @@ public class NativeBiometric extends Plugin {
         NATIVE_BIOMETRIC_SHARED_PREFERENCES,
         Context.MODE_PRIVATE
       );
-    String username = sharedPreferences.getString("username", null);
-    String password = sharedPreferences.getString("password", null);
+    String username = sharedPreferences.getString(
+      KEY_ALIAS + "-username",
+      null
+    );
+    String password = sharedPreferences.getString(
+      KEY_ALIAS + "-password",
+      null
+    );
     if (KEY_ALIAS != null) {
       if (username != null && password != null) {
         try {
@@ -215,10 +239,10 @@ public class NativeBiometric extends Plugin {
           jsObject.put("username", decryptString(username, KEY_ALIAS));
           jsObject.put("password", decryptString(password, KEY_ALIAS));
           call.resolve(jsObject);
-        } catch (GeneralSecurityException e) {
-          call.reject("Failed to get credentials", e);
-        } catch (IOException e) {
-          call.reject("Failed to get credentials", e);
+        } catch (GeneralSecurityException | IOException e) {
+          // Can get here if not authenticated.
+          String errorMessage = "Failed to get credentials";
+          call.reject(errorMessage);
         }
       } else {
         call.reject("No credentials found");
@@ -232,22 +256,21 @@ public class NativeBiometric extends Plugin {
   private void verifyResult(PluginCall call, ActivityResult result) {
     if (result.getResultCode() == Activity.RESULT_OK) {
       Intent data = result.getData();
-      if (data.hasExtra("result")) {
+      if (data != null && data.hasExtra("result")) {
         switch (data.getStringExtra("result")) {
           case "success":
             call.resolve();
             break;
           case "failed":
+          case "error":
             call.reject(
               data.getStringExtra("errorDetails"),
               data.getStringExtra("errorCode")
             );
             break;
           default:
-            call.reject(
-              "Verification error: " + data.getStringExtra("result"),
-              data.getStringExtra("errorCode")
-            );
+            // Should not get to here unless AuthActivity starts returning different Activity Results.
+            call.reject("Something went wrong.");
             break;
         }
       }
@@ -272,13 +295,12 @@ public class NativeBiometric extends Plugin {
         editor.clear();
         editor.apply();
         call.resolve();
-      } catch (KeyStoreException e) {
-        call.reject("Failed to delete", e);
-      } catch (CertificateException e) {
-        call.reject("Failed to delete", e);
-      } catch (NoSuchAlgorithmException e) {
-        call.reject("Failed to delete", e);
-      } catch (IOException e) {
+      } catch (
+        KeyStoreException
+        | CertificateException
+        | NoSuchAlgorithmException
+        | IOException e
+      ) {
         call.reject("Failed to delete", e);
       }
     } else {
@@ -324,23 +346,39 @@ public class NativeBiometric extends Plugin {
     return new String(decryptedData, "UTF-8");
   }
 
+  @SuppressLint("NewAPI") // API level is already checked
   private Key generateKey(String KEY_ALIAS)
     throws GeneralSecurityException, IOException {
+    Key key;
+    try {
+      key = generateKey(KEY_ALIAS, true);
+    } catch (StrongBoxUnavailableException e) {
+      key = generateKey(KEY_ALIAS, false);
+    }
+    return key;
+  }
+
+  private Key generateKey(String KEY_ALIAS, boolean isStrongBoxBacked)
+    throws GeneralSecurityException, IOException, StrongBoxUnavailableException {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
       KeyGenerator generator = KeyGenerator.getInstance(
         KeyProperties.KEY_ALGORITHM_AES,
         ANDROID_KEY_STORE
       );
-      generator.init(
-        new KeyGenParameterSpec.Builder(
-          KEY_ALIAS,
-          KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT
-        )
-          .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
-          .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
-          .setRandomizedEncryptionRequired(false)
-          .build()
-      );
+      KeyGenParameterSpec.Builder paramBuilder = new KeyGenParameterSpec.Builder(
+        KEY_ALIAS,
+        KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT
+      )
+        .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
+        .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
+        .setRandomizedEncryptionRequired(false);
+
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+        paramBuilder.setUnlockedDeviceRequired(true);
+        paramBuilder.setIsStrongBoxBacked(isStrongBoxBacked);
+      }
+
+      generator.init(paramBuilder.build());
       return generator.generateKey();
     } else {
       return getAESKey(KEY_ALIAS);
@@ -349,8 +387,8 @@ public class NativeBiometric extends Plugin {
 
   private Key getKey(String KEY_ALIAS)
     throws GeneralSecurityException, IOException {
-    KeyStore.SecretKeyEntry secretKeyEntry =
-      (KeyStore.SecretKeyEntry) getKeyStore().getEntry(KEY_ALIAS, null);
+    KeyStore.SecretKeyEntry secretKeyEntry = (KeyStore.SecretKeyEntry) getKeyStore()
+      .getEntry(KEY_ALIAS, null);
     if (secretKeyEntry != null) {
       return secretKeyEntry.getSecretKey();
     }
@@ -359,13 +397,11 @@ public class NativeBiometric extends Plugin {
 
   private KeyStore getKeyStore()
     throws KeyStoreException, CertificateException, NoSuchAlgorithmException, IOException {
-    if (keyStore != null) {
-      return keyStore;
-    } else {
+    if (keyStore == null) {
       keyStore = KeyStore.getInstance(ANDROID_KEY_STORE);
       keyStore.load(null);
-      return keyStore;
     }
+    return keyStore;
   }
 
   private Key getAESKey(String KEY_ALIAS)
@@ -392,8 +428,8 @@ public class NativeBiometric extends Plugin {
 
   private KeyStore.PrivateKeyEntry getPrivateKeyEntry(String KEY_ALIAS)
     throws NoSuchProviderException, NoSuchAlgorithmException, InvalidAlgorithmParameterException, CertificateException, KeyStoreException, IOException, UnrecoverableEntryException {
-    KeyStore.PrivateKeyEntry privateKeyEntry =
-      (KeyStore.PrivateKeyEntry) getKeyStore().getEntry(KEY_ALIAS, null);
+    KeyStore.PrivateKeyEntry privateKeyEntry = (KeyStore.PrivateKeyEntry) getKeyStore()
+      .getEntry(KEY_ALIAS, null);
 
     if (privateKeyEntry == null) {
       KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance(
@@ -454,4 +490,15 @@ public class NativeBiometric extends Plugin {
     }
     return bytes;
   }
+
+  private boolean deviceHasCredentials() {
+    KeyguardManager keyguardManager = (KeyguardManager) getActivity()
+      .getSystemService(Context.KEYGUARD_SERVICE);
+    // Can only use fallback if the device has a pin/pattern/password lockscreen.
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+      return keyguardManager.isDeviceSecure();
+    } else {
+      return keyguardManager.isKeyguardSecure();
+    }
+  }
 }

package/dist/docs.json

@@ -7,12 +7,12 @@
     "methods": [
       {
         "name": "isAvailable",
-        "signature": "(options?: IsAvailableOptions) => any",
+        "signature": "(options?: IsAvailableOptions | undefined) => any",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "IsAvailableOptions"
+            "type": "IsAvailableOptions | undefined"
           }
         ],
         "returns": "any",
@@ -42,12 +42,12 @@
       },
       {
         "name": "verifyIdentity",
-        "signature": "(options?: BiometricOptions) => any",
+        "signature": "(options?: BiometricOptions | undefined) => any",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "BiometricOptions"
+            "type": "BiometricOptions | undefined"
           }
         ],
         "returns": "any",
@@ -225,7 +225,7 @@
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         }
       ]
     },
@@ -241,42 +241,49 @@
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "title",
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "subtitle",
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "description",
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "negativeButtonText",
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "useFallback",
           "tags": [],
-          "docs": "",
+          "docs": "Specifies if should fallback to passcode authentication if biometric authentication fails.",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "fallbackTitle",
+          "tags": [],
+          "docs": "Only for iOS.\nSet the text for the fallback button in the authentication dialog.\nIf this property is not specified, the default text is set by the system.",
+          "complexTypes": [],
+          "type": "string | undefined"
         },
         {
           "name": "maxAttempts",
@@ -288,7 +295,7 @@
           ],
           "docs": "Only for Android.\nSet a maximum number of attempts for biometric authentication. The maximum allowed by android is 5.",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         }
       ]
     },
@@ -385,36 +392,43 @@
       "members": [
         {
           "name": "NONE",
+          "value": "0",
           "tags": [],
           "docs": ""
         },
         {
           "name": "TOUCH_ID",
+          "value": "1",
           "tags": [],
           "docs": ""
         },
         {
           "name": "FACE_ID",
+          "value": "2",
           "tags": [],
           "docs": ""
         },
         {
           "name": "FINGERPRINT",
+          "value": "3",
           "tags": [],
           "docs": ""
         },
         {
           "name": "FACE_AUTHENTICATION",
+          "value": "4",
           "tags": [],
           "docs": ""
         },
         {
           "name": "IRIS_AUTHENTICATION",
+          "value": "5",
           "tags": [],
           "docs": ""
         },
         {
           "name": "MULTIPLE",
+          "value": "6",
           "tags": [],
           "docs": ""
         }

package/dist/esm/definitions.d.ts

@@ -28,7 +28,16 @@ export interface BiometricOptions {
     subtitle?: string;
     description?: string;
     negativeButtonText?: string;
+    /**
+     * Specifies if should fallback to passcode authentication if biometric authentication fails.
+     */
     useFallback?: boolean;
+    /**
+     * Only for iOS.
+     * Set the text for the fallback button in the authentication dialog.
+     * If this property is not specified, the default text is set by the system.
+     */
+    fallbackTitle?: string;
     /**
      * Only for Android.
      * Set a maximum number of attempts for biometric authentication. The maximum allowed by android is 5.
@@ -47,6 +56,25 @@ export interface SetCredentialOptions {
 export interface DeleteCredentialOptions {
     server: string;
 }
+/**
+ * Keep this in sync with BiometricAuthError in README.md
+ * Update whenever `convertToPluginErrorCode` functions are modified
+ */
+export declare enum BiometricAuthError {
+    UNKNOWN_ERROR = 0,
+    BIOMETRICS_UNAVAILABLE = 1,
+    USER_LOCKOUT = 2,
+    BIOMETRICS_NOT_ENROLLED = 3,
+    USER_TEMPORARY_LOCKOUT = 4,
+    AUTHENTICATION_FAILED = 10,
+    APP_CANCEL = 11,
+    INVALID_CONTEXT = 12,
+    NOT_INTERACTIVE = 13,
+    PASSCODE_NOT_SET = 14,
+    SYSTEM_CANCEL = 15,
+    USER_CANCEL = 16,
+    USER_FALLBACK = 17
+}
 export interface NativeBiometricPlugin {
     /**
      * Checks if biometric authentication hardware is available.
@@ -63,7 +91,7 @@ export interface NativeBiometricPlugin {
      * @memberof NativeBiometricPlugin
      * @since 1.0.0
      */
-    verifyIdentity(options?: BiometricOptions): Promise<any>;
+    verifyIdentity(options?: BiometricOptions): Promise<void>;
     /**
      * Gets the stored credentials for a given server.
      * @param {GetCredentialOptions} options
@@ -79,7 +107,7 @@ export interface NativeBiometricPlugin {
      * @memberof NativeBiometricPlugin
      * @since 1.0.0
      */
-    setCredentials(options: SetCredentialOptions): Promise<any>;
+    setCredentials(options: SetCredentialOptions): Promise<void>;
     /**
      * Deletes the stored credentials for a given server.
      * @param {DeleteCredentialOptions} options
@@ -87,5 +115,5 @@ export interface NativeBiometricPlugin {
      * @memberof NativeBiometricPlugin
      * @since 1.0.0
      */
-    deleteCredentials(options: DeleteCredentialOptions): Promise<any>;
+    deleteCredentials(options: DeleteCredentialOptions): Promise<void>;
 }

package/dist/esm/definitions.js

@@ -1,11 +1,38 @@
 export var BiometryType;
 (function (BiometryType) {
+    // Android, iOS
     BiometryType[BiometryType["NONE"] = 0] = "NONE";
+    // iOS
     BiometryType[BiometryType["TOUCH_ID"] = 1] = "TOUCH_ID";
+    // iOS
     BiometryType[BiometryType["FACE_ID"] = 2] = "FACE_ID";
+    // Android
     BiometryType[BiometryType["FINGERPRINT"] = 3] = "FINGERPRINT";
+    // Android
     BiometryType[BiometryType["FACE_AUTHENTICATION"] = 4] = "FACE_AUTHENTICATION";
+    // Android
     BiometryType[BiometryType["IRIS_AUTHENTICATION"] = 5] = "IRIS_AUTHENTICATION";
+    // Android
     BiometryType[BiometryType["MULTIPLE"] = 6] = "MULTIPLE";
 })(BiometryType || (BiometryType = {}));
+/**
+ * Keep this in sync with BiometricAuthError in README.md
+ * Update whenever `convertToPluginErrorCode` functions are modified
+ */
+export var BiometricAuthError;
+(function (BiometricAuthError) {
+    BiometricAuthError[BiometricAuthError["UNKNOWN_ERROR"] = 0] = "UNKNOWN_ERROR";
+    BiometricAuthError[BiometricAuthError["BIOMETRICS_UNAVAILABLE"] = 1] = "BIOMETRICS_UNAVAILABLE";
+    BiometricAuthError[BiometricAuthError["USER_LOCKOUT"] = 2] = "USER_LOCKOUT";
+    BiometricAuthError[BiometricAuthError["BIOMETRICS_NOT_ENROLLED"] = 3] = "BIOMETRICS_NOT_ENROLLED";
+    BiometricAuthError[BiometricAuthError["USER_TEMPORARY_LOCKOUT"] = 4] = "USER_TEMPORARY_LOCKOUT";
+    BiometricAuthError[BiometricAuthError["AUTHENTICATION_FAILED"] = 10] = "AUTHENTICATION_FAILED";
+    BiometricAuthError[BiometricAuthError["APP_CANCEL"] = 11] = "APP_CANCEL";
+    BiometricAuthError[BiometricAuthError["INVALID_CONTEXT"] = 12] = "INVALID_CONTEXT";
+    BiometricAuthError[BiometricAuthError["NOT_INTERACTIVE"] = 13] = "NOT_INTERACTIVE";
+    BiometricAuthError[BiometricAuthError["PASSCODE_NOT_SET"] = 14] = "PASSCODE_NOT_SET";
+    BiometricAuthError[BiometricAuthError["SYSTEM_CANCEL"] = 15] = "SYSTEM_CANCEL";
+    BiometricAuthError[BiometricAuthError["USER_CANCEL"] = 16] = "USER_CANCEL";
+    BiometricAuthError[BiometricAuthError["USER_FALLBACK"] = 17] = "USER_FALLBACK";
+})(BiometricAuthError || (BiometricAuthError = {}));
 //# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,+CAAI,CAAA;IACJ,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,6DAAW,CAAA;IACX,6EAAmB,CAAA;IACnB,6EAAmB,CAAA;IACnB,uDAAQ,CAAA;AACV,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB"}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,eAAe;IACf,+CAAQ,CAAA;IACR,MAAM;IACN,uDAAY,CAAA;IACZ,MAAM;IACN,qDAAW,CAAA;IACX,UAAU;IACV,6DAAe,CAAA;IACf,UAAU;IACV,6EAAuB,CAAA;IACvB,UAAU;IACV,6EAAuB,CAAA;IACvB,UAAU;IACV,uDAAY,CAAA;AACd,CAAC,EAfW,YAAY,KAAZ,YAAY,QAevB;AA0DD;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAcX;AAdD,WAAY,kBAAkB;IAC5B,6EAAiB,CAAA;IACjB,+FAA0B,CAAA;IAC1B,2EAAgB,CAAA;IAChB,iGAA2B,CAAA;IAC3B,+FAA0B,CAAA;IAC1B,8FAA0B,CAAA;IAC1B,wEAAe,CAAA;IACf,kFAAoB,CAAA;IACpB,kFAAoB,CAAA;IACpB,oFAAqB,CAAA;IACrB,8EAAkB,CAAA;IAClB,0EAAgB,CAAA;IAChB,8EAAkB,CAAA;AACpB,CAAC,EAdW,kBAAkB,KAAlB,kBAAkB,QAc7B","sourcesContent":["export enum BiometryType {\n  // Android, iOS\n  NONE = 0,\n  // iOS\n  TOUCH_ID = 1,\n  // iOS\n  FACE_ID = 2,\n  // Android\n  FINGERPRINT = 3,\n  // Android\n  FACE_AUTHENTICATION = 4,\n  // Android\n  IRIS_AUTHENTICATION = 5,\n  // Android\n  MULTIPLE = 6,\n}\n\nexport interface Credentials {\n  username: string;\n  password: string;\n}\n\nexport interface IsAvailableOptions {\n  /**\n   * Specifies if should fallback to passcode authentication if biometric authentication is not available.\n   */\n  useFallback: boolean;\n}\n\nexport interface AvailableResult {\n  isAvailable: boolean;\n  biometryType: BiometryType;\n  errorCode?: number;\n}\n\nexport interface BiometricOptions {\n  reason?: string;\n  title?: string;\n  subtitle?: string;\n  description?: string;\n  negativeButtonText?: string;\n  /**\n   * Specifies if should fallback to passcode authentication if biometric authentication fails.\n   */\n  useFallback?: boolean;\n  /**\n   * Only for iOS.\n   * Set the text for the fallback button in the authentication dialog.\n   * If this property is not specified, the default text is set by the system.\n   */\n  fallbackTitle?: string;\n  /**\n   * Only for Android.\n   * Set a maximum number of attempts for biometric authentication. The maximum allowed by android is 5.\n   * @default 1\n   */\n  maxAttempts?: number;\n}\n\nexport interface GetCredentialOptions {\n  server: string;\n}\n\nexport interface SetCredentialOptions {\n  username: string;\n  password: string;\n  server: string;\n}\n\nexport interface DeleteCredentialOptions {\n  server: string;\n}\n\n/**\n * Keep this in sync with BiometricAuthError in README.md\n * Update whenever `convertToPluginErrorCode` functions are modified\n */\nexport enum BiometricAuthError {\n  UNKNOWN_ERROR = 0,\n  BIOMETRICS_UNAVAILABLE = 1,\n  USER_LOCKOUT = 2,\n  BIOMETRICS_NOT_ENROLLED = 3,\n  USER_TEMPORARY_LOCKOUT = 4,\n  AUTHENTICATION_FAILED = 10,\n  APP_CANCEL = 11,\n  INVALID_CONTEXT = 12,\n  NOT_INTERACTIVE = 13,\n  PASSCODE_NOT_SET = 14,\n  SYSTEM_CANCEL = 15,\n  USER_CANCEL = 16,\n  USER_FALLBACK = 17,\n}\n\nexport interface NativeBiometricPlugin {\n  /**\n   * Checks if biometric authentication hardware is available.\n   * @param {IsAvailableOptions} [options]\n   * @returns {Promise<AvailableResult>}\n   * @memberof NativeBiometricPlugin\n   * @since 1.0.0\n   */\n  isAvailable(options?: IsAvailableOptions): Promise<AvailableResult>;\n  /**\n   * Prompts the user to authenticate with biometrics.\n   * @param {BiometricOptions} [options]\n   * @returns {Promise<any>}\n   * @memberof NativeBiometricPlugin\n   * @since 1.0.0\n   */\n  verifyIdentity(options?: BiometricOptions): Promise<void>;\n  /**\n   * Gets the stored credentials for a given server.\n   * @param {GetCredentialOptions} options\n   * @returns {Promise<Credentials>}\n   * @memberof NativeBiometricPlugin\n   * @since 1.0.0\n   */\n  getCredentials(options: GetCredentialOptions): Promise<Credentials>;\n  /**\n   * Stores the given credentials for a given server.\n   * @param {SetCredentialOptions} options\n   * @returns {Promise<any>}\n   * @memberof NativeBiometricPlugin\n   * @since 1.0.0\n   */\n  setCredentials(options: SetCredentialOptions): Promise<void>;\n  /**\n   * Deletes the stored credentials for a given server.\n   * @param {DeleteCredentialOptions} options\n   * @returns {Promise<any>}\n   * @memberof NativeBiometricPlugin\n   * @since 1.0.0\n   */\n  deleteCredentials(options: DeleteCredentialOptions): Promise<void>;\n}\n"]}

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,eAAe,GAAG,cAAc,CACpC,iBAAiB,EACjB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;CACnE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,eAAe,GAAG,cAAc,CACpC,iBAAiB,EACjB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;CACnE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAC","sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\n\nimport type { NativeBiometricPlugin } from \"./definitions\";\n\nconst NativeBiometric = registerPlugin<NativeBiometricPlugin>(\n  \"NativeBiometric\",\n  {\n    web: () => import(\"./web\").then((m) => new m.NativeBiometricWeb()),\n  }\n);\n\nexport * from \"./definitions\";\nexport { NativeBiometric };\n"]}

package/dist/esm/web.d.ts

@@ -3,8 +3,8 @@ import type { NativeBiometricPlugin, AvailableResult, BiometricOptions, GetCrede
 export declare class NativeBiometricWeb extends WebPlugin implements NativeBiometricPlugin {
     constructor();
     isAvailable(): Promise<AvailableResult>;
-    verifyIdentity(_options?: BiometricOptions): Promise<any>;
+    verifyIdentity(_options?: BiometricOptions): Promise<void>;
     getCredentials(_options: GetCredentialOptions): Promise<Credentials>;
-    setCredentials(_options: SetCredentialOptions): Promise<any>;
-    deleteCredentials(_options: DeleteCredentialOptions): Promise<any>;
+    setCredentials(_options: SetCredentialOptions): Promise<void>;
+    deleteCredentials(_options: DeleteCredentialOptions): Promise<void>;
 }

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAY5C,MAAM,OAAO,kBACX,SAAQ,SAAS;IAGjB;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IACD,WAAW;QACT,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,cAAc,CAAC,QAA2B;QACxC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,cAAc,CAAC,QAA8B;QAC3C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,cAAc,CAAC,QAA8B;QAC3C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,iBAAiB,CAAC,QAAiC;QACjD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;CACF"}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAY5C,MAAM,OAAO,kBACX,SAAQ,SAAS;IAGjB;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IACD,WAAW;QACT,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,cAAc,CAAC,QAA2B;QACxC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,cAAc,CAAC,QAA8B;QAC3C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,cAAc,CAAC,QAA8B;QAC3C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,iBAAiB,CAAC,QAAiC;QACjD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;CACF","sourcesContent":["import { WebPlugin } from \"@capacitor/core\";\n\nimport type {\n  NativeBiometricPlugin,\n  AvailableResult,\n  BiometricOptions,\n  GetCredentialOptions,\n  SetCredentialOptions,\n  DeleteCredentialOptions,\n  Credentials,\n} from \"./definitions\";\n\nexport class NativeBiometricWeb\n  extends WebPlugin\n  implements NativeBiometricPlugin\n{\n  constructor() {\n    super();\n  }\n  isAvailable(): Promise<AvailableResult> {\n    throw new Error(\"Method not implemented.\");\n  }\n\n  verifyIdentity(_options?: BiometricOptions): Promise<void> {\n    throw new Error(\"Method not implemented.\");\n  }\n  getCredentials(_options: GetCredentialOptions): Promise<Credentials> {\n    throw new Error(\"Method not implemented.\");\n  }\n  setCredentials(_options: SetCredentialOptions): Promise<void> {\n    throw new Error(\"Method not implemented.\");\n  }\n  deleteCredentials(_options: DeleteCredentialOptions): Promise<void> {\n    throw new Error(\"Method not implemented.\");\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -1,17 +1,40 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var core = require('@capacitor/core');
 
-exports.BiometryType = void 0;
 (function (BiometryType) {
+    // Android, iOS
     BiometryType[BiometryType["NONE"] = 0] = "NONE";
+    // iOS
     BiometryType[BiometryType["TOUCH_ID"] = 1] = "TOUCH_ID";
+    // iOS
     BiometryType[BiometryType["FACE_ID"] = 2] = "FACE_ID";
+    // Android
     BiometryType[BiometryType["FINGERPRINT"] = 3] = "FINGERPRINT";
+    // Android
     BiometryType[BiometryType["FACE_AUTHENTICATION"] = 4] = "FACE_AUTHENTICATION";
+    // Android
     BiometryType[BiometryType["IRIS_AUTHENTICATION"] = 5] = "IRIS_AUTHENTICATION";
+    // Android
     BiometryType[BiometryType["MULTIPLE"] = 6] = "MULTIPLE";
 })(exports.BiometryType || (exports.BiometryType = {}));
+(function (BiometricAuthError) {
+    BiometricAuthError[BiometricAuthError["UNKNOWN_ERROR"] = 0] = "UNKNOWN_ERROR";
+    BiometricAuthError[BiometricAuthError["BIOMETRICS_UNAVAILABLE"] = 1] = "BIOMETRICS_UNAVAILABLE";
+    BiometricAuthError[BiometricAuthError["USER_LOCKOUT"] = 2] = "USER_LOCKOUT";
+    BiometricAuthError[BiometricAuthError["BIOMETRICS_NOT_ENROLLED"] = 3] = "BIOMETRICS_NOT_ENROLLED";
+    BiometricAuthError[BiometricAuthError["USER_TEMPORARY_LOCKOUT"] = 4] = "USER_TEMPORARY_LOCKOUT";
+    BiometricAuthError[BiometricAuthError["AUTHENTICATION_FAILED"] = 10] = "AUTHENTICATION_FAILED";
+    BiometricAuthError[BiometricAuthError["APP_CANCEL"] = 11] = "APP_CANCEL";
+    BiometricAuthError[BiometricAuthError["INVALID_CONTEXT"] = 12] = "INVALID_CONTEXT";
+    BiometricAuthError[BiometricAuthError["NOT_INTERACTIVE"] = 13] = "NOT_INTERACTIVE";
+    BiometricAuthError[BiometricAuthError["PASSCODE_NOT_SET"] = 14] = "PASSCODE_NOT_SET";
+    BiometricAuthError[BiometricAuthError["SYSTEM_CANCEL"] = 15] = "SYSTEM_CANCEL";
+    BiometricAuthError[BiometricAuthError["USER_CANCEL"] = 16] = "USER_CANCEL";
+    BiometricAuthError[BiometricAuthError["USER_FALLBACK"] = 17] = "USER_FALLBACK";
+})(exports.BiometricAuthError || (exports.BiometricAuthError = {}));
 
 const NativeBiometric = core.registerPlugin("NativeBiometric", {
     web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.NativeBiometricWeb()),