@aparajita/capacitor-biometric-auth 8.0.2 → 9.1.0

package/AparajitaCapacitorBiometricAuth.podspec

@@ -12,7 +12,7 @@
     s.author = package['author']
     s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
     s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
-    s.ios.deployment_target  = '13.0'
+    s.ios.deployment_target  = '14.0'
     s.dependency 'Capacitor'
     s.swift_version = '5.1'
   end

package/README.md

@@ -2,7 +2,7 @@
 
 # capacitor-biometric-auth  [![npm version](https://badge.fury.io/js/@aparajita%2Fcapacitor-biometric-auth.svg)](https://badge.fury.io/js/@aparajita%2Fcapacitor-biometric-auth)
 
-This plugin for [Capacitor 6](https://capacitorjs.com) provides access to native biometry and device credentials on iOS and Android. It supports every type of biometry and every configuration option on both platforms. In addition, biometry and device credentials are simulated on the web so you can test your logic without making any changes to your code.
+This plugin for [Capacitor 7](https://capacitorjs.com) provides access to native biometry and device credentials on iOS and Android. It supports every type of biometry and every configuration option on both platforms. In addition, biometry and device credentials are simulated on the web so you can test your logic without making any changes to your code.
 
 🛑 **BREAKING CHANGES:**
 
@@ -10,7 +10,7 @@ This plugin for [Capacitor 6](https://capacitorjs.com) provides access to native
 
 - If you are upgrading from a version prior to 7.0.0, please note that [`authenticate()`](#authenticate) will _immediately_ present a prompt for device credentials if `deviceIsSecure` is true, `allowDeviceCredentials` is true, and no biometry of the requested strength is available.
 
-- If you are upgrading from a version prior to 8.0.0, please note that this plugin now requires Capacitor 6+.
+- If you are upgrading from a version prior to 8.0.0, please note that this plugin now requires Capacitor 7+.
 
 - If you are upgrading from a version prior to 8.0.0, please note that [`addResumeListener`](#addresumelistener) now always returns a Promise and must be awaited.
 
@@ -42,11 +42,23 @@ The API is extensively documented in the [TypeScript definitions file](src/defin
 
 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.
+- `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.
+  - Biometry has been disabled for the current app.
+  - On Android, biometric hardware is present but can only be used for _device_ unlock, _not_ by apps. see the [Android note](#android-note) below for more information.
 
-- On iOS, `isAvailable` and `strongBiometryIsAvailable` will always have the same value. On Android, `isAvailable` will be `true` if _any_ type of biometry is available, but `strongBiometryIsAvailable` will be `true` only if strong biometry is available. For example, on a typical device, if the device supports both fingerprint and face authentication, `isAvailable` will be `true` if either is enrolled, but `strongBiometryIsAvailable` will be `true` only if fingerprint authentication is enrolled.
+  In such cases the `reason` and `code` will tell you why.
 
-- `biometryTypes` may contain more than one type of biometry. This occurs on Android devices that support multiple types of biometry. In such cases `biometryType` will indicate the primary (most secure) type of biometry, and the `biometryTypes` array will contain all of the biometry types supported by the device. Note that Android only guarantees that one of the types is actually available.
+- On iOS, `isAvailable` and `strongBiometryIsAvailable` will always have the same value, because traditionally that’s the whole point of biometry — it’s supposed to be strong authentication.
+- Android unfortunately supports “strong” biometry (usually fingerprint) and “weak” biometry (usually face/iris). `isAvailable` will be `true` if _any_ type of biometry is actually available for use by the app, but `strongBiometryIsAvailable` will be `true` only if strong biometry is available. For example, on a typical device, if it has hardware support for both fingerprint and face unlock, and both are available for use by apps, `isAvailable` will be `true` if either is enrolled, but `strongBiometryIsAvailable` will be `true` only if fingerprint authentication is enrolled.
+
+#### ❗Android note
+
+When it comes to biometry, Android is frankly a bit of a mess. Some devices may support “weak” biometry (e.g. face unlock) only for device unlock, and not by apps. But the system reports to this plugin _all_ types of biometric hardware, even if they are not available for use by apps.
+
+👉 Therefore on Android the only thing you can rely on are the `isAvailable` and `strongBiometryAvailable` properties as simple on/off switches. Do NOT rely on `biometryType` and `biometryTypes` as an indication of what biometry you can actually use.
+
+#### Handling app resume
 
 Because the availability of biometry can change while your app is in the background, it’s important to check availability when your app resumes. By calling [`addResumeListener()`](#addresumelistener) you can register a callback that is passed a [`CheckBiometryResult`](#checkbiometryresult) when your app resumes.
 
@@ -138,7 +150,9 @@ On iOS, Touch ID and Face ID are supported.
 
 ### Android
 
-On Android, fingerprint, face, and iris authentication are supported. Note that if a device supports more than one type of biometry, the plugin will initially present the primary (most secure) available type, which is determined by the system.
+On Android, fingerprint, face, and iris authentication are supported. Note that if a device supports more than one type of biometry, the plugin will initially present the primary (most secure) available type, which is determined by the system and cannot be determined programmatically.
+
+❗ As discussed above, Android may support multiple types of biometry, but not all of them may be available for use by apps. For example, a device may support both fingerprint and face authentication, but only fingerprint authentication may be available for use by apps. In such cases, if the user has enrolled in face authentication only, `checkBiometry()` will indicate that biometry is not available.
 
 ## API
 
@@ -248,75 +262,17 @@ Register a function that will be called when the app resumes. The function will
 
 #### CheckBiometryResult
 
-| Prop                      | Type                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| :------------------------ | :------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| isAvailable               | boolean                                            | True if the device supports _at least_ weak biometric authentication and the current user has enrolled in some form of biometry. Note that if `strongBiometryIsAvailable` is true, this will also be true.                                                                                                                                                                                                                                                                                                                           |
-| strongBiometryIsAvailable | boolean                                            | True if the device has strong biometric authentication capability and the current user has enrolled in that strong biometry.<br><br>On iOS this value and `isAvailable` will always be the same, since iOS only supports strong biometry.<br><br>On Android, for example, if the device supports both fingerprint and face authentication, and the user has enrolled only in face authentication, and Android considers face authentication on that device to be weak, then `isAvailable` will be true but this value will be false. |
-| biometryType              | <a href="#biometrytype">BiometryType</a>           | The primary (most secure) type of biometry supported by the device. Note that _supported_ is not the same as _available_, which requires the biometry to be enrolled.                                                                                                                                                                                                                                                                                                                                                                |
-| biometryTypes             | BiometryType[]                                     | All of the biometry types supported by the hardware on the device (currently only Android devices support multiple biometry types). If no biometry is supported, i.e. `biometryType === <a href="#biometrytype">BiometryType.none`</a>, this will be an empty array.<br><br>Note that _supported_ is not the same as _available_, which requires the biometry to be enrolled.                                                                                                                                                        |
-| deviceIsSecure            | boolean                                            | Returns true if the device is secure. On iOS, this means that the device has a passcode set. On Android, this means that the device has a PIN, pattern, or password set.                                                                                                                                                                                                                                                                                                                                                             |
-| reason                    | string                                             | If weak or better biometry is not available and the system gives a reason why, it will be returned here. Otherwise it's an empty string.                                                                                                                                                                                                                                                                                                                                                                                             |
-| code                      | <a href="#biometryerrortype">BiometryErrorType</a> | If weak or better biometry is not available, the error code will be returned here. Otherwise it's an empty string. The error code will be one of the <a href="#biometryerrortype">`BiometryErrorType`</a> enum values, and is consistent across platforms.                                                                                                                                                                                                                                                                           |
-| strongReason              | string                                             | If strong biometry is not available and the system gives a reason why, it will be returned here. Otherwise it's an empty string.<br><br>On iOS, this will always be the same as `reason`, since all biometry on iOS is strong.                                                                                                                                                                                                                                                                                                       |
-| strongCode                | <a href="#biometryerrortype">BiometryErrorType</a> | If strong biometry is not available, the error code will be returned here. Otherwise it's an empty string. The error code will be one of the <a href="#biometryerrortype">`BiometryErrorType`</a> enum values, and is consistent across platforms.<br><br>On iOS, this will always be the same as `code`, since all biometry on iOS is strong.                                                                                                                                                                                       |
-
-#### Array
-
-| Prop   | Type   | Description                                                                                            |
-| :----- | :----- | :----------------------------------------------------------------------------------------------------- |
-| length | number | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
-
-| Method                                                                      | Signature                                                                      | Description                                                                                                           |
-| :-------------------------------------------------------------------------- | :----------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- |
-| **toString**                                                                | () =&gt; string                                                                | Returns a string representation of an array.                                                                          |
-| **toLocaleString**                                                          | () =&gt; string                                                                | Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. |
-| **pop**                                                                     | () =&gt; T \| undefined                                                        | Removes the last element from an array and returns it.                                                                |
-| If the array is empty, undefined is returned and the array is not modified. |
-| **push**                                                                    | (...items: T[]) =&gt; number                                                   | Appends new elements to the end of an array, and returns the new length of the array.                                 |
-| **concat**                                                                  | (...items: <a href="#concatarray">ConcatArray</a>&lt;T&gt;[]) =&gt; T[]        | Combines two or more arrays.                                                                                          |
-| This method returns a new array without modifying any existing arrays.      |
-| **concat**                                                                  | (...items: (T \| <a href="#concatarray">ConcatArray</a>&lt;T&gt;)[]) =&gt; T[] | Combines two or more arrays.                                                                                          |
-| This method returns a new array without modifying any existing arrays.      |
-| **join**                                                                    | (separator?: string) =&gt; string                                              | Adds all the elements of an array into a string, separated by the specified separator string.                         |
-| **reverse**                                                                 | () =&gt; T[]                                                                   | Reverses the elements in an array in place.                                                                           |
-| This method mutates the array and returns a reference to the same array.    |
-| **shift**                                                                   | () =&gt; T \| undefined                                                        | Removes the first element from an array and returns it.                                                               |
-| If the array is empty, undefined is returned and the array is not modified. |
-| **slice**                                                                   | (start?: number, end?: number) =&gt; T[]                                       | Returns a copy of a section of an array.                                                                              |
-
-For both start and end, a negative index can be used to indicate an offset from the end of the array.
-For example, -2 refers to the second to last element of the array. |
-| **sort** | (compareFn?: ((a: T, b: T) =&gt; number) \| undefined) =&gt; this | Sorts an array in place.
-This method mutates the array and returns a reference to the same array. |
-| **splice** | (start: number, deleteCount?: number) =&gt; T[] | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
-| **splice** | (start: number, deleteCount: number, ...items: T[]) =&gt; T[] | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
-| **unshift** | (...items: T[]) =&gt; number | Inserts new elements at the start of an array, and returns the new length of the array. |
-| **indexOf** | (searchElement: T, fromIndex?: number) =&gt; number | Returns the index of the first occurrence of a value in an array, or -1 if it is not present. |
-| **lastIndexOf** | (searchElement: T, fromIndex?: number) =&gt; number | Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. |
-| **every** | &lt;S extends T&gt;(predicate: (value: T, index: number, array: T[]) =&gt; value is S, thisArg?: any) =&gt; this is S[] | Determines whether all the members of an array satisfy the specified test. |
-| **every** | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; boolean | Determines whether all the members of an array satisfy the specified test. |
-| **some** | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; boolean | Determines whether the specified callback function returns true for any element of an array. |
-| **forEach** | (callbackfn: (value: T, index: number, array: T[]) =&gt; void, thisArg?: any) =&gt; void | Performs the specified action for each element in an array. |
-| **map** | &lt;U&gt;(callbackfn: (value: T, index: number, array: T[]) =&gt; U, thisArg?: any) =&gt; U[] | Calls a defined callback function on each element of an array, and returns an array that contains the results. |
-| **filter** | &lt;S extends T&gt;(predicate: (value: T, index: number, array: T[]) =&gt; value is S, thisArg?: any) =&gt; S[] | Returns the elements of an array that meet the condition specified in a callback function. |
-| **filter** | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; T[] | Returns the elements of an array that meet the condition specified in a callback function. |
-| **reduce** | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T) =&gt; T | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |
-| **reduce** | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T, initialValue: T) =&gt; T | |
-| **reduce** | &lt;U&gt;(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) =&gt; U, initialValue: U) =&gt; U | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |
-| **reduceRight** | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T) =&gt; T | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |
-| **reduceRight** | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T, initialValue: T) =&gt; T | |
-| **reduceRight** | &lt;U&gt;(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) =&gt; U, initialValue: U) =&gt; U | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |
-
-#### ConcatArray
-
-| Prop   | Type   |
-| :----- | :----- |
-| length | number |
-
-| Method    | Signature                                |
-| :-------- | :--------------------------------------- |
-| **join**  | (separator?: string) =&gt; string        |
-| **slice** | (start?: number, end?: number) =&gt; T[] |
+| Property                  | Type                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| :------------------------ | :------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| isAvailable               | boolean                                            | True if the device supports _at least_ weak biometric authentication _by apps_ and the current user has enrolled in some form of biometry. Note that if `strongBiometryIsAvailable` is true, this will also be true.                                                                                                                                                                                                                                                                                                                         |
+| strongBiometryIsAvailable | boolean                                            | True if the device has strong biometric authentication capability and the current user has enrolled in that strong biometry.<br><br>On iOS this value and `isAvailable` will always be the same, since iOS only supports strong biometry.<br><br>On Android, for example, if the device supports both fingerprint and face authentication by apps, and the user has enrolled only in face authentication, and Android considers face authentication on that device to be weak, then `isAvailable` will be true but this value will be false. |
+| biometryType              | <a href="#biometrytype">BiometryType</a>           | The primary (most secure) type of biometry supported by the device. Note that _supported_ is not the same as _available_, which requires the biometry to be enrolled.                                                                                                                                                                                                                                                                                                                                                                        |
+| biometryTypes             | BiometryType[]                                     | All of the biometry types supported by the hardware on the device, _whether or not it is actually available for use by apps_. If no biometry is supported, i.e. `biometryType === <a href="#biometrytype">BiometryType.none`</a>, this will be an empty array.<br><br>Note that _supported_ is not the same as _available_, which requires the biometry to be enrolled.                                                                                                                                                                      |
+| deviceIsSecure            | boolean                                            | Returns true if the device is secure. On iOS, this means that the device has a passcode set. On Android, this means that the device has a PIN, pattern, or password set.                                                                                                                                                                                                                                                                                                                                                                     |
+| reason                    | string                                             | If weak or better biometry is not available and the system gives a reason why, it will be returned here. Otherwise it's an empty string.                                                                                                                                                                                                                                                                                                                                                                                                     |
+| code                      | <a href="#biometryerrortype">BiometryErrorType</a> | If weak or better biometry is not available, the error code will be returned here. Otherwise it's an empty string. The error code will be one of the <a href="#biometryerrortype">`BiometryErrorType`</a> enum values, and is consistent across platforms.                                                                                                                                                                                                                                                                                   |
+| strongReason              | string                                             | If strong biometry is not available and the system gives a reason why, it will be returned here. Otherwise it's an empty string.<br><br>On iOS, this will always be the same as `reason`, since all biometry on iOS is strong.                                                                                                                                                                                                                                                                                                               |
+| strongCode                | <a href="#biometryerrortype">BiometryErrorType</a> | If strong biometry is not available, the error code will be returned here. Otherwise it's an empty string. The error code will be one of the <a href="#biometryerrortype">`BiometryErrorType`</a> enum values, and is consistent across platforms.<br><br>On iOS, this will always be the same as `code`, since all biometry on iOS is strong.                                                                                                                                                                                               |
 
 #### AuthenticateOptions
 

package/android/build.gradle

@@ -1,5 +1,7 @@
 ext {
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
 }
 
 buildscript {
@@ -8,7 +10,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.2.2'
+        classpath 'com.android.tools.build:gradle:8.13.0'
     }
 }
 
@@ -16,12 +18,12 @@ apply plugin: 'com.android.library'
 
 android {
     namespace "com.aparajita.capacitor.biometricauth"
-    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
     defaultConfig {
-        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
-        versionCode 1
-        versionName "1.0"
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 2
+        versionName "9.1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
     buildTypes {
@@ -34,8 +36,8 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_17
-        targetCompatibility JavaVersion.VERSION_17
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
     }
 }
 
@@ -49,6 +51,6 @@ dependencies {
     implementation 'androidx.biometric:biometric:1.1.0'
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
-    implementation 'androidx.appcompat:appcompat:1.7.0'
-    implementation 'com.google.android.material:material:1.12.0'
+    implementation 'androidx.appcompat:appcompat:1.7.1'
+    implementation 'com.google.android.material:material:1.13.0'
 }

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

@@ -26,7 +26,7 @@ public class AuthActivity extends AppCompatActivity {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
       executor = this.getMainExecutor();
     } else {
-      executor = command -> new Handler(this.getMainLooper()).post(command);
+      executor = (command) -> new Handler(this.getMainLooper()).post(command);
     }
 
     BiometricPrompt.PromptInfo.Builder builder =

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

@@ -158,8 +158,10 @@ public class BiometricAuthNative extends Plugin {
 
     result.put("biometryTypes", returnTypes);
 
-    KeyguardManager keyguardManager = (KeyguardManager) this.getContext()
-      .getSystemService(Context.KEYGUARD_SERVICE);
+    KeyguardManager keyguardManager =
+      (KeyguardManager) this.getContext().getSystemService(
+        Context.KEYGUARD_SERVICE
+      );
 
     if (keyguardManager != null) {
       result.put("deviceIsSecure", keyguardManager.isKeyguardSecure());

package/dist/esm/base.d.ts

@@ -1,6 +1,6 @@
-import { WebPlugin } from '@capacitor/core';
 import type { PluginListenerHandle } from '@capacitor/core';
-import type { AuthenticateOptions, BiometricAuthPlugin, CheckBiometryResult, ResumeListener, BiometryType } from './definitions';
+import { WebPlugin } from '@capacitor/core';
+import type { AuthenticateOptions, BiometricAuthPlugin, BiometryType, CheckBiometryResult, ResumeListener } from './definitions';
 export declare abstract class BiometricAuthBase extends WebPlugin implements BiometricAuthPlugin {
     abstract setBiometryType(type: BiometryType | string | Array<BiometryType | string> | undefined): Promise<void>;
     abstract checkBiometry(): Promise<CheckBiometryResult>;

package/dist/esm/base.js

@@ -1,6 +1,6 @@
 import { App } from '@capacitor/app';
 import { CapacitorException, WebPlugin } from '@capacitor/core';
-import { BiometryError } from './definitions';
+import { BiometryError, isBiometryErrorType } from './definitions';
 export class BiometricAuthBase extends WebPlugin {
     async authenticate(options) {
         try {
@@ -9,22 +9,25 @@ export class BiometricAuthBase extends WebPlugin {
         catch (error) {
             // error will be an instance of CapacitorException on native platforms,
             // an instance of BiometryError on the web.
-            if (error instanceof CapacitorException) {
-                throw new BiometryError(error.message, error.code);
-            }
-            else {
-                throw error;
-            }
+            throw error instanceof CapacitorException &&
+                isBiometryErrorType(error.code)
+                ? new BiometryError(error.message, error.code)
+                : error;
         }
     }
     async addResumeListener(listener) {
         return App.addListener('appStateChange', ({ isActive }) => {
             if (isActive) {
-                this.checkBiometry()
-                    .then((info) => {
-                    listener(info);
-                })
-                    .catch(console.error);
+                ;
+                (async () => {
+                    try {
+                        const info = await this.checkBiometry();
+                        listener(info);
+                    }
+                    catch (error) {
+                        console.error(error);
+                    }
+                })();
             }
         });
     }

package/dist/esm/definitions.d.ts

@@ -158,11 +158,11 @@ export declare enum BiometryErrorType {
     biometryNotEnrolled = "biometryNotEnrolled",
     noDeviceCredential = "noDeviceCredential"
 }
+export declare function isBiometryErrorType(value: unknown): value is BiometryErrorType;
 /**
  * `authenticate()` throws instances of this class.
  */
-export declare class BiometryError {
-    message: string;
+export declare class BiometryError extends Error {
     code: BiometryErrorType;
     constructor(message: string, code: BiometryErrorType);
 }

package/dist/esm/definitions.js

@@ -61,12 +61,21 @@ export var BiometryErrorType;
     BiometryErrorType["biometryNotEnrolled"] = "biometryNotEnrolled";
     BiometryErrorType["noDeviceCredential"] = "noDeviceCredential";
 })(BiometryErrorType || (BiometryErrorType = {}));
+export function isBiometryErrorType(value) {
+    return (typeof value === 'string' &&
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+        Object.values(BiometryErrorType).includes(value));
+}
 /**
  * `authenticate()` throws instances of this class.
  */
-export class BiometryError {
+export class BiometryError extends Error {
     constructor(message, code) {
-        this.message = message;
+        super(message);
         this.code = code;
+        this.name = 'BiometryError';
+        // Set the prototype explicitly to ensure instanceof works correctly.
+        // This is recommended for custom error classes in TypeScript.
+        Object.setPrototypeOf(this, BiometryError.prototype);
     }
 }

package/dist/esm/index.js

@@ -1,8 +1,17 @@
 import { registerPlugin } from '@capacitor/core';
 const proxy = registerPlugin('BiometricAuthNative', {
-    web: async () => import('./web').then((module) => new module.BiometricAuthWeb()),
-    ios: async () => import('./native').then((module) => new module.BiometricAuthNative(proxy)),
-    android: async () => import('./native').then((module) => new module.BiometricAuthNative(proxy)),
+    web: async () => {
+        const module = await import('./web');
+        return new module.BiometricAuthWeb();
+    },
+    ios: async () => {
+        const module = await import('./native');
+        return new module.BiometricAuthNative(proxy);
+    },
+    android: async () => {
+        const module = await import('./native');
+        return new module.BiometricAuthNative(proxy);
+    },
 });
 export * from './definitions';
 export * from './web-utils';

package/dist/esm/native.d.ts

@@ -4,8 +4,8 @@ import { BiometryType } from './definitions';
 export declare class BiometricAuthNative extends BiometricAuthBase {
     constructor(capProxy: BiometricAuthPlugin);
     checkBiometry(): Promise<CheckBiometryResult>;
-    internalAuthenticate(options?: AuthenticateOptions): Promise<void>;
-    setBiometryType(type: BiometryType | string | Array<BiometryType | string> | undefined): Promise<void>;
-    setBiometryIsEnrolled(enrolled: boolean): Promise<void>;
-    setDeviceIsSecure(isSecure: boolean): Promise<void>;
+    internalAuthenticate(_options?: AuthenticateOptions): Promise<void>;
+    setBiometryType(_type: BiometryType | string | Array<BiometryType | string> | undefined): Promise<void>;
+    setBiometryIsEnrolled(_enrolled: boolean): Promise<void>;
+    setDeviceIsSecure(_isSecure: boolean): Promise<void>;
 }

package/dist/esm/native.js

@@ -1,7 +1,6 @@
 import { BiometricAuthBase } from './base';
 import { BiometryErrorType, BiometryType } from './definitions';
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/require-await */
-// eslint-disable-next-line import/prefer-default-export
+/* eslint-disable @typescript-eslint/class-methods-use-this, @typescript-eslint/require-await */
 export class BiometricAuthNative extends BiometricAuthBase {
     constructor(capProxy) {
         super();
@@ -13,6 +12,7 @@ export class BiometricAuthNative extends BiometricAuthBase {
           capProxy is a proxy of an instance of this class, so it is safe
           to cast it to this class.
         */
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
         const proxy = capProxy;
         /* eslint-disable @typescript-eslint/unbound-method */
         this.checkBiometry = proxy.checkBiometry;
@@ -22,7 +22,7 @@ export class BiometricAuthNative extends BiometricAuthBase {
     // @native
     async checkBiometry() {
         // Never used, but we have to satisfy the compiler.
-        return Promise.resolve({
+        return {
             isAvailable: false,
             strongBiometryIsAvailable: false,
             biometryType: BiometryType.none,
@@ -32,21 +32,24 @@ export class BiometricAuthNative extends BiometricAuthBase {
             code: BiometryErrorType.none,
             strongReason: '',
             strongCode: BiometryErrorType.none,
-        });
+        };
     }
     // @native
     // On native platforms, this will present the native authentication UI.
-    async internalAuthenticate(options) { }
+    async internalAuthenticate(_options) {
+        // This method is implemented natively
+    }
     // Web only, used for simulating biometric authentication.
-    async setBiometryType(type) {
+    async setBiometryType(_type) {
         console.warn('setBiometryType() is web only');
     }
     // Web only, used for simulating biometry enrollment.
-    async setBiometryIsEnrolled(enrolled) {
+    async setBiometryIsEnrolled(_enrolled) {
         console.warn('setBiometryEnrolled() is web only');
     }
     // Web only, used for simulating device security.
-    async setDeviceIsSecure(isSecure) {
+    async setDeviceIsSecure(_isSecure) {
         console.warn('setDeviceIsSecure() is web only');
     }
 }
+/* eslint-enable @typescript-eslint/class-methods-use-this, @typescript-eslint/require-await */

package/dist/esm/web-utils.js

@@ -10,7 +10,6 @@ const kBiometryTypeNameMap = {
 /**
  * Return a human-readable name for a BiometryType.
  */
-// eslint-disable-next-line import/prefer-default-export
 export function getBiometryName(type) {
     return kBiometryTypeNameMap[type] || '';
 }

package/dist/esm/web.js

@@ -1,7 +1,7 @@
 import { BiometricAuthBase } from './base';
 import { BiometryError, BiometryErrorType, BiometryType } from './definitions';
 import { getBiometryName } from './web-utils';
-// eslint-disable-next-line import/prefer-default-export
+/* eslint-disable @typescript-eslint/require-await */
 export class BiometricAuthWeb extends BiometricAuthBase {
     constructor() {
         super(...arguments);
@@ -24,7 +24,7 @@ export class BiometricAuthWeb extends BiometricAuthBase {
             reason = 'Biometry is not enrolled';
             code = BiometryErrorType.biometryNotEnrolled;
         }
-        return Promise.resolve({
+        return {
             isAvailable: available,
             strongBiometryIsAvailable: this.biometryIsEnrolled && this.hasStrongBiometry(),
             biometryType: this.biometryType,
@@ -32,38 +32,36 @@ export class BiometricAuthWeb extends BiometricAuthBase {
             deviceIsSecure: this.deviceIsSecure,
             reason,
             code,
-        });
+        };
     }
     hasStrongBiometry() {
         return this.biometryTypes.some((type) => type === BiometryType.faceId ||
             type === BiometryType.touchId ||
             type === BiometryType.fingerprintAuthentication);
     }
-    /* eslint-disable no-alert */
     // On the web, fake authentication with a confirm dialog.
     async internalAuthenticate(options) {
         const result = await this.checkBiometry();
         // First try biometry if available.
-        if (result.isAvailable) {
-            if (confirm(
+        if (result.isAvailable &&
+            // oxlint-disable-next-line no-alert
+            confirm(
             // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- we want to use the default value if options?.reason is an empty string
             (options === null || options === void 0 ? void 0 : options.reason) ||
                 `Authenticate with ${result.biometryTypes
                     .map((type) => getBiometryName(type))
                     .join(' or ')}?`)) {
-                return;
-            }
+            return;
         }
         if (options === null || options === void 0 ? void 0 : options.allowDeviceCredential) {
             // Either biometry is not available, or the user declined to use it
             // and device security is allowed.
             if (result.deviceIsSecure) {
+                // oxlint-disable-next-line no-alert
                 if (confirm('Authenticate with device security?')) {
                     return;
                 }
-                else {
-                    throw new BiometryError('User cancelled', BiometryErrorType.userCancel);
-                }
+                throw new BiometryError('User cancelled', BiometryErrorType.userCancel);
             }
             else if (result.isAvailable) {
                 throw new BiometryError('Device is not secure', BiometryErrorType.noDeviceCredential);
@@ -71,12 +69,9 @@ export class BiometricAuthWeb extends BiometricAuthBase {
         }
         else if (!result.isAvailable) {
             // Biometry is not available and device security is not allowed.
-            if (result.biometryType === BiometryType.none) {
-                throw new BiometryError('Biometry is not available', BiometryErrorType.biometryNotAvailable);
-            }
-            else {
-                throw new BiometryError('Biometry is not enrolled', BiometryErrorType.biometryNotEnrolled);
-            }
+            throw result.biometryType === BiometryType.none
+                ? new BiometryError('Biometry is not available', BiometryErrorType.biometryNotAvailable)
+                : new BiometryError('Biometry is not enrolled', BiometryErrorType.biometryNotEnrolled);
         }
         // The user declined to use biometry and device credentials not allowed.
         throw new BiometryError('User cancelled', BiometryErrorType.userCancel);
@@ -84,13 +79,13 @@ export class BiometricAuthWeb extends BiometricAuthBase {
     // Web only, used for simulating biometric authentication.
     async setBiometryType(type) {
         if (type === undefined) {
-            return Promise.resolve();
+            return;
         }
         const types = Array.isArray(type) ? type : [type];
         this.biometryTypes = [];
         this.biometryType = BiometryType.none;
         if (types.length === 0) {
-            return Promise.resolve();
+            return;
         }
         if (isBiometryTypes(types)) {
             this.biometryType = types[0];
@@ -99,35 +94,35 @@ export class BiometricAuthWeb extends BiometricAuthBase {
             }
         }
         else {
-            for (let i = 0; i < types.length; i++) {
-                // eslint-disable-next-line no-prototype-builtins
-                if (BiometryType.hasOwnProperty(types[i])) {
-                    const biometryType = BiometryType[types[i]];
+            for (const [i, theType] of types.entries()) {
+                if (isBiometryType(theType)) {
                     if (this.biometryType === BiometryType.none) {
                         this.biometryTypes = [];
                     }
                     else {
-                        this.biometryTypes.push(biometryType);
+                        this.biometryTypes.push(theType);
                     }
                     if (i === 0) {
-                        this.biometryType = biometryType;
+                        this.biometryType = theType;
                     }
                 }
             }
         }
-        return Promise.resolve();
     }
     // Web only, used for simulating device unlock security.
     async setBiometryIsEnrolled(enrolled) {
         this.biometryIsEnrolled = enrolled;
-        return Promise.resolve();
     }
     // Web only, used for simulating device unlock security.
     async setDeviceIsSecure(isSecure) {
         this.deviceIsSecure = isSecure;
-        return Promise.resolve();
     }
 }
+function isBiometryType(value) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+    return Object.values(BiometryType).includes(value);
+}
 function isBiometryTypes(value) {
-    return Object.values(BiometryType).includes(value[0]);
+    return value.every((type) => isBiometryType(type));
 }
+/* eslint-enable @typescript-eslint/require-await */