@aparajita/capacitor-biometric-auth 3.1.4 → 5.0.0

package/README.md

@@ -32,7 +32,7 @@ The API is extensively documented in the [TypeScript definitions file](src/defin
 
 ### 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 is available on the device. Note that `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` will tell you why.
+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 is available on the device. Note that `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.
 
 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.
 
@@ -109,7 +109,7 @@ web only<br><br>On the web, this method allows you to dynamically simulate diffe
 authenticate(options?: AuthenticateOptions) => Promise<void>
 ```
 
-Prompt the user for authentication. If authorization fails for any reason, the promise is rejected with a `BiometryError`.<br><br>For detailed information about the behavior on iOS, see:<br><br>https://developer.apple.com/documentation/localauthentication/lapolicy/deviceownerauthenticationwithbiometrics<br><br>Some versions of Android impose a limit on the number of failed attempts. If `allowDeviceCredential` is `true`, when the limit is reached the user will then be presented with a device credential prompt. If `allowDeviceCredential` is `false`, when the limit is reached `authenticate()` will reject with a `BiometryErrorType` of `biometryLockout`, after which the user will have to wait the system-defined length of time before being allowed to authenticate again.
+Prompt the user for authentication. If authorization fails for any reason, the promise is rejected with a `BiometryError`.<br><br>For detailed information about the behavior on iOS, see:<br><br>https://developer.apple.com/documentation/localauthentication/lapolicy/deviceownerauthenticationwithbiometrics<br><br>Some versions of Android impose a limit on the number of failed attempts. If `allowDeviceCredential` is `true`, when the limit is reached the user will then be presented with a device credential prompt. If `allowDeviceCredential` is `false`, when the limit is reached `authenticate()` will reject with a <a href="#biometryerrortype">`BiometryErrorType`</a> of `biometryLockout`, after which the user will have to wait the system-defined length of time before being allowed to authenticate again.
 
 | Param   | Type                                                   |
 | :------ | :----------------------------------------------------- |
@@ -137,11 +137,12 @@ Register a function that will be called when the app resumes. The function will
 
 #### CheckBiometryResult
 
-| Prop         | Type                                     | Description                                                                                                               |
-| :----------- | :--------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |
-| isAvailable  | boolean                                  | True if the device has biometric authentication capability and the current user has enrolled in biometry.                 |
-| biometryType | <a href="#biometrytype">BiometryType</a> | The type of biometry available on the device.                                                                             |
-| reason       | string                                   | If biometry is not available and the system gives a reason why, it will be returned here. Otherwise it's an empty string. |
+| Prop         | Type                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| :----------- | :------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| isAvailable  | boolean                                            | True if the device has biometric authentication capability and the current user has enrolled in biometry.                                                                                                                                                                                                                                                                                                                                        |
+| biometryType | <a href="#biometrytype">BiometryType</a>           | The type of biometry available on the device.                                                                                                                                                                                                                                                                                                                                                                                                    |
+| reason       | string                                             | If 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 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. This allows you to check for specific errors in a platform- independent way, for example:<br><br>if (result.code === <a href="#biometryerrortype">BiometryErrorType.biometryNotEnrolled</a>) { ... } |
 
 #### AuthenticateOptions
 
@@ -181,5 +182,23 @@ The signature of the callback passed to `addResumeListener()`.
 | faceAuthentication        | Android face authentication is available        |
 | irisAuthentication        | Android iris authentication is available        |
 
+#### BiometryErrorType
+
+| Members              | Value                  |
+| :------------------- | :--------------------- |
+| none                 | ''                     |
+| appCancel            | 'appCancel'            |
+| authenticationFailed | 'authenticationFailed' |
+| invalidContext       | 'invalidContext'       |
+| notInteractive       | 'notInteractive'       |
+| passcodeNotSet       | 'passcodeNotSet'       |
+| systemCancel         | 'systemCancel'         |
+| userCancel           | 'userCancel'           |
+| userFallback         | 'userFallback'         |
+| biometryLockout      | 'biometryLockout'      |
+| biometryNotAvailable | 'biometryNotAvailable' |
+| biometryNotEnrolled  | 'biometryNotEnrolled'  |
+| noDeviceCredential   | 'noDeviceCredential'   |
+
 </docgen-api>
 </div>

package/android/build.gradle

@@ -1,7 +1,8 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
 }
 
 buildscript {
@@ -10,17 +11,18 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.3'
+        classpath 'com.android.tools.build:gradle:8.0.2'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    namespace "com.aparajita.capacitor.biometricauth"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -35,8 +37,8 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
 }
 
@@ -50,11 +52,11 @@ dependencies {
     implementation 'androidx.biometric:biometric:1.1.0'
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
-    implementation 'androidx.appcompat:appcompat:1.4.2'
-    implementation 'com.google.android.material:material:1.6.1'
+    implementation 'androidx.appcompat:appcompat:1.6.1'
+    implementation 'com.google.android.material:material:1.9.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
-    implementation 'androidx.navigation:navigation-fragment:2.5.1'
-    implementation 'androidx.navigation:navigation-ui:2.5.1'
+    implementation 'androidx.navigation:navigation-fragment:2.6.0'
+    implementation 'androidx.navigation:navigation-ui:2.6.0'
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"

package/android/src/main/AndroidManifest.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.aparajita.capacitor.biometricauth">
+    >
 
     <application>
       <activity

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

@@ -35,10 +35,6 @@ public class AuthActivity extends AppCompatActivity {
     String title = intent.getStringExtra(BiometricAuthNative.TITLE);
     String subtitle = intent.getStringExtra(BiometricAuthNative.SUBTITLE);
     String description = intent.getStringExtra(BiometricAuthNative.REASON);
-    final int maxAttempts = intent.getIntExtra(
-      BiometricAuthNative.MAX_ATTEMPTS,
-      BiometricAuthNative.DEFAULT_MAX_ATTEMPTS
-    );
     allowDeviceCredential = false;
 
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {

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

@@ -120,17 +120,24 @@ public class BiometricAuthNative extends Plugin {
         reason = "There is no biometric hardware on this device.";
         break;
       case BiometricManager.BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED:
-        reason = "The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors.";
+        reason = "The user can’t authenticate because a security vulnerability has been discovered with one or more hardware sensors.";
         break;
       case BiometricManager.BIOMETRIC_ERROR_UNSUPPORTED:
-        reason = "The user can't authenticate because the specified options are incompatible with the current Android version.";
+        reason = "The user can’t authenticate because the specified options are incompatible with the current Android version.";
         break;
       case BiometricManager.BIOMETRIC_STATUS_UNKNOWN:
         reason = "Unable to determine whether the user can authenticate.";
         break;
     }
 
+    String errorCode = biometryErrorCodeMap.get(biometryResult);
+
+    if (errorCode == null) {
+      errorCode = "biometryNotAvailable";
+    }
+
     ret.put("reason", reason);
+    ret.put("code", errorCode);
     call.resolve(ret);
   }
 

package/dist/esm/definitions.d.ts

@@ -110,18 +110,19 @@ export interface AuthenticateOptions {
  * for a description of each error code.
  */
 export declare enum BiometryErrorType {
-    appCancel = 0,
-    authenticationFailed = 1,
-    invalidContext = 2,
-    notInteractive = 3,
-    passcodeNotSet = 4,
-    systemCancel = 5,
-    userCancel = 6,
-    userFallback = 7,
-    biometryLockout = 8,
-    biometryNotAvailable = 9,
-    biometryNotEnrolled = 10,
-    noDeviceCredential = 11
+    none = "",
+    appCancel = "appCancel",
+    authenticationFailed = "authenticationFailed",
+    invalidContext = "invalidContext",
+    notInteractive = "notInteractive",
+    passcodeNotSet = "passcodeNotSet",
+    systemCancel = "systemCancel",
+    userCancel = "userCancel",
+    userFallback = "userFallback",
+    biometryLockout = "biometryLockout",
+    biometryNotAvailable = "biometryNotAvailable",
+    biometryNotEnrolled = "biometryNotEnrolled",
+    noDeviceCredential = "noDeviceCredential"
 }
 export interface ResultError extends PluginResultError {
     code: string;
@@ -146,11 +147,23 @@ export interface CheckBiometryResult {
      * it will be returned here. Otherwise it's an empty string.
      */
     reason: string;
+    /**
+     * If 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
+     * `BiometryErrorType` enum values, and is consistent across
+     * platforms. This allows you to check for specific errors in a platform-
+     * independent way, for example:
+     *
+     * if (result.code === BiometryErrorType.biometryNotEnrolled) {
+     *   ...
+     * }
+     */
+    code: BiometryErrorType;
 }
 /**
  * The signature of the callback passed to `addResumeListener()`.
  */
-export declare type ResumeListener = (info: CheckBiometryResult) => void;
+export type ResumeListener = (info: CheckBiometryResult) => void;
 export interface BiometricAuthPlugin extends WebPlugin {
     /**
      * Check to see what biometry type (if any) is available.

package/dist/esm/definitions.js

@@ -35,22 +35,23 @@ export var BiometryType;
  */
 export var BiometryErrorType;
 (function (BiometryErrorType) {
-    BiometryErrorType[BiometryErrorType["appCancel"] = 0] = "appCancel";
-    BiometryErrorType[BiometryErrorType["authenticationFailed"] = 1] = "authenticationFailed";
-    BiometryErrorType[BiometryErrorType["invalidContext"] = 2] = "invalidContext";
-    BiometryErrorType[BiometryErrorType["notInteractive"] = 3] = "notInteractive";
-    BiometryErrorType[BiometryErrorType["passcodeNotSet"] = 4] = "passcodeNotSet";
-    BiometryErrorType[BiometryErrorType["systemCancel"] = 5] = "systemCancel";
-    BiometryErrorType[BiometryErrorType["userCancel"] = 6] = "userCancel";
-    BiometryErrorType[BiometryErrorType["userFallback"] = 7] = "userFallback";
-    BiometryErrorType[BiometryErrorType["biometryLockout"] = 8] = "biometryLockout";
-    BiometryErrorType[BiometryErrorType["biometryNotAvailable"] = 9] = "biometryNotAvailable";
-    BiometryErrorType[BiometryErrorType["biometryNotEnrolled"] = 10] = "biometryNotEnrolled";
-    BiometryErrorType[BiometryErrorType["noDeviceCredential"] = 11] = "noDeviceCredential";
+    BiometryErrorType["none"] = "";
+    BiometryErrorType["appCancel"] = "appCancel";
+    BiometryErrorType["authenticationFailed"] = "authenticationFailed";
+    BiometryErrorType["invalidContext"] = "invalidContext";
+    BiometryErrorType["notInteractive"] = "notInteractive";
+    BiometryErrorType["passcodeNotSet"] = "passcodeNotSet";
+    BiometryErrorType["systemCancel"] = "systemCancel";
+    BiometryErrorType["userCancel"] = "userCancel";
+    BiometryErrorType["userFallback"] = "userFallback";
+    BiometryErrorType["biometryLockout"] = "biometryLockout";
+    BiometryErrorType["biometryNotAvailable"] = "biometryNotAvailable";
+    BiometryErrorType["biometryNotEnrolled"] = "biometryNotEnrolled";
+    BiometryErrorType["noDeviceCredential"] = "noDeviceCredential";
 })(BiometryErrorType || (BiometryErrorType = {}));
 export class BiometryError {
     constructor(message, code) {
         this.message = message;
-        this.code = BiometryErrorType[code];
+        this.code = code;
     }
 }

package/dist/esm/index.js

@@ -1,10 +1,8 @@
 import { registerPlugin } from '@capacitor/core';
-import info from './info.json';
-console.log(`loaded ${info.name} v${info.version}`);
 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))
+    android: async () => import('./native').then((module) => new module.BiometricAuthNative(proxy)),
 });
 export * from './definitions';
 export * from './web-utils';

package/dist/esm/native.js

@@ -1,5 +1,5 @@
 import { BiometricAuthBase } from './base';
-import { BiometryType } from './definitions';
+import { BiometryErrorType, BiometryType } from './definitions';
 // eslint-disable-next-line import/prefer-default-export
 export class BiometricAuthNative extends BiometricAuthBase {
     constructor(capProxy) {
@@ -12,7 +12,8 @@ export class BiometricAuthNative extends BiometricAuthBase {
         return Promise.resolve({
             isAvailable: true,
             biometryType: BiometryType.none,
-            reason: ''
+            reason: '',
+            code: BiometryErrorType.none,
         });
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars,@typescript-eslint/no-empty-function

package/dist/esm/web-utils.js

@@ -5,7 +5,7 @@ const kBiometryTypeNameMap = {
     [BiometryType.faceId]: 'Face ID',
     [BiometryType.fingerprintAuthentication]: 'Fingerprint Authentication',
     [BiometryType.faceAuthentication]: 'Face Authentication',
-    [BiometryType.irisAuthentication]: 'Iris Authentication'
+    [BiometryType.irisAuthentication]: 'Iris Authentication',
 };
 /**
  * Return a human-readable name for a BiometryType.

package/dist/esm/web.js

@@ -11,7 +11,8 @@ export class BiometricAuthWeb extends BiometricAuthBase {
         return Promise.resolve({
             isAvailable: this.biometryType !== BiometryType.none,
             biometryType: this.biometryType,
-            reason: ''
+            reason: '',
+            code: BiometryErrorType.none,
         });
     }
     async authenticate(options) {

package/dist/plugin.cjs.js

@@ -1,15 +1,8 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var core = require('@capacitor/core');
 var app = require('@capacitor/app');
 
-var info = {
-  name: "@aparajita/capacitor-biometric-auth",
-  version: "3.1.4"
-};
-
 exports.BiometryType = void 0;
 (function (BiometryType) {
     /**
@@ -47,23 +40,24 @@ exports.BiometryType = void 0;
  */
 exports.BiometryErrorType = void 0;
 (function (BiometryErrorType) {
-    BiometryErrorType[BiometryErrorType["appCancel"] = 0] = "appCancel";
-    BiometryErrorType[BiometryErrorType["authenticationFailed"] = 1] = "authenticationFailed";
-    BiometryErrorType[BiometryErrorType["invalidContext"] = 2] = "invalidContext";
-    BiometryErrorType[BiometryErrorType["notInteractive"] = 3] = "notInteractive";
-    BiometryErrorType[BiometryErrorType["passcodeNotSet"] = 4] = "passcodeNotSet";
-    BiometryErrorType[BiometryErrorType["systemCancel"] = 5] = "systemCancel";
-    BiometryErrorType[BiometryErrorType["userCancel"] = 6] = "userCancel";
-    BiometryErrorType[BiometryErrorType["userFallback"] = 7] = "userFallback";
-    BiometryErrorType[BiometryErrorType["biometryLockout"] = 8] = "biometryLockout";
-    BiometryErrorType[BiometryErrorType["biometryNotAvailable"] = 9] = "biometryNotAvailable";
-    BiometryErrorType[BiometryErrorType["biometryNotEnrolled"] = 10] = "biometryNotEnrolled";
-    BiometryErrorType[BiometryErrorType["noDeviceCredential"] = 11] = "noDeviceCredential";
+    BiometryErrorType["none"] = "";
+    BiometryErrorType["appCancel"] = "appCancel";
+    BiometryErrorType["authenticationFailed"] = "authenticationFailed";
+    BiometryErrorType["invalidContext"] = "invalidContext";
+    BiometryErrorType["notInteractive"] = "notInteractive";
+    BiometryErrorType["passcodeNotSet"] = "passcodeNotSet";
+    BiometryErrorType["systemCancel"] = "systemCancel";
+    BiometryErrorType["userCancel"] = "userCancel";
+    BiometryErrorType["userFallback"] = "userFallback";
+    BiometryErrorType["biometryLockout"] = "biometryLockout";
+    BiometryErrorType["biometryNotAvailable"] = "biometryNotAvailable";
+    BiometryErrorType["biometryNotEnrolled"] = "biometryNotEnrolled";
+    BiometryErrorType["noDeviceCredential"] = "noDeviceCredential";
 })(exports.BiometryErrorType || (exports.BiometryErrorType = {}));
 class BiometryError {
     constructor(message, code) {
         this.message = message;
-        this.code = exports.BiometryErrorType[code];
+        this.code = code;
     }
 }
 
@@ -73,7 +67,7 @@ const kBiometryTypeNameMap = {
     [exports.BiometryType.faceId]: 'Face ID',
     [exports.BiometryType.fingerprintAuthentication]: 'Fingerprint Authentication',
     [exports.BiometryType.faceAuthentication]: 'Face Authentication',
-    [exports.BiometryType.irisAuthentication]: 'Iris Authentication'
+    [exports.BiometryType.irisAuthentication]: 'Iris Authentication',
 };
 /**
  * Return a human-readable name for a BiometryType.
@@ -83,11 +77,10 @@ function getBiometryName(type) {
     return kBiometryTypeNameMap[type] || '';
 }
 
-console.log(`loaded ${info.name} v${info.version}`);
 const proxy = core.registerPlugin('BiometricAuthNative', {
     web: async () => Promise.resolve().then(function () { return web; }).then((module) => new module.BiometricAuthWeb()),
     ios: async () => Promise.resolve().then(function () { return native; }).then((module) => new module.BiometricAuthNative(proxy)),
-    android: async () => Promise.resolve().then(function () { return native; }).then((module) => new module.BiometricAuthNative(proxy))
+    android: async () => Promise.resolve().then(function () { return native; }).then((module) => new module.BiometricAuthNative(proxy)),
 });
 
 // eslint-disable-next-line import/prefer-default-export
@@ -115,7 +108,8 @@ class BiometricAuthWeb extends BiometricAuthBase {
         return Promise.resolve({
             isAvailable: this.biometryType !== exports.BiometryType.none,
             biometryType: this.biometryType,
-            reason: ''
+            reason: '',
+            code: exports.BiometryErrorType.none,
         });
     }
     async authenticate(options) {
@@ -167,7 +161,8 @@ class BiometricAuthNative extends BiometricAuthBase {
         return Promise.resolve({
             isAvailable: true,
             biometryType: exports.BiometryType.none,
-            reason: ''
+            reason: '',
+            code: exports.BiometryErrorType.none,
         });
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars,@typescript-eslint/no-empty-function

package/dist/plugin.js

@@ -1,11 +1,6 @@
 var capacitorBiometricAuth = (function (exports, core, app) {
     'use strict';
 
-    var info = {
-      name: "@aparajita/capacitor-biometric-auth",
-      version: "3.1.4"
-    };
-
     exports.BiometryType = void 0;
     (function (BiometryType) {
         /**
@@ -43,23 +38,24 @@ var capacitorBiometricAuth = (function (exports, core, app) {
      */
     exports.BiometryErrorType = void 0;
     (function (BiometryErrorType) {
-        BiometryErrorType[BiometryErrorType["appCancel"] = 0] = "appCancel";
-        BiometryErrorType[BiometryErrorType["authenticationFailed"] = 1] = "authenticationFailed";
-        BiometryErrorType[BiometryErrorType["invalidContext"] = 2] = "invalidContext";
-        BiometryErrorType[BiometryErrorType["notInteractive"] = 3] = "notInteractive";
-        BiometryErrorType[BiometryErrorType["passcodeNotSet"] = 4] = "passcodeNotSet";
-        BiometryErrorType[BiometryErrorType["systemCancel"] = 5] = "systemCancel";
-        BiometryErrorType[BiometryErrorType["userCancel"] = 6] = "userCancel";
-        BiometryErrorType[BiometryErrorType["userFallback"] = 7] = "userFallback";
-        BiometryErrorType[BiometryErrorType["biometryLockout"] = 8] = "biometryLockout";
-        BiometryErrorType[BiometryErrorType["biometryNotAvailable"] = 9] = "biometryNotAvailable";
-        BiometryErrorType[BiometryErrorType["biometryNotEnrolled"] = 10] = "biometryNotEnrolled";
-        BiometryErrorType[BiometryErrorType["noDeviceCredential"] = 11] = "noDeviceCredential";
+        BiometryErrorType["none"] = "";
+        BiometryErrorType["appCancel"] = "appCancel";
+        BiometryErrorType["authenticationFailed"] = "authenticationFailed";
+        BiometryErrorType["invalidContext"] = "invalidContext";
+        BiometryErrorType["notInteractive"] = "notInteractive";
+        BiometryErrorType["passcodeNotSet"] = "passcodeNotSet";
+        BiometryErrorType["systemCancel"] = "systemCancel";
+        BiometryErrorType["userCancel"] = "userCancel";
+        BiometryErrorType["userFallback"] = "userFallback";
+        BiometryErrorType["biometryLockout"] = "biometryLockout";
+        BiometryErrorType["biometryNotAvailable"] = "biometryNotAvailable";
+        BiometryErrorType["biometryNotEnrolled"] = "biometryNotEnrolled";
+        BiometryErrorType["noDeviceCredential"] = "noDeviceCredential";
     })(exports.BiometryErrorType || (exports.BiometryErrorType = {}));
     class BiometryError {
         constructor(message, code) {
             this.message = message;
-            this.code = exports.BiometryErrorType[code];
+            this.code = code;
         }
     }
 
@@ -69,7 +65,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         [exports.BiometryType.faceId]: 'Face ID',
         [exports.BiometryType.fingerprintAuthentication]: 'Fingerprint Authentication',
         [exports.BiometryType.faceAuthentication]: 'Face Authentication',
-        [exports.BiometryType.irisAuthentication]: 'Iris Authentication'
+        [exports.BiometryType.irisAuthentication]: 'Iris Authentication',
     };
     /**
      * Return a human-readable name for a BiometryType.
@@ -79,11 +75,10 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         return kBiometryTypeNameMap[type] || '';
     }
 
-    console.log(`loaded ${info.name} v${info.version}`);
     const proxy = core.registerPlugin('BiometricAuthNative', {
         web: async () => Promise.resolve().then(function () { return web; }).then((module) => new module.BiometricAuthWeb()),
         ios: async () => Promise.resolve().then(function () { return native; }).then((module) => new module.BiometricAuthNative(proxy)),
-        android: async () => Promise.resolve().then(function () { return native; }).then((module) => new module.BiometricAuthNative(proxy))
+        android: async () => Promise.resolve().then(function () { return native; }).then((module) => new module.BiometricAuthNative(proxy)),
     });
 
     // eslint-disable-next-line import/prefer-default-export
@@ -111,7 +106,8 @@ var capacitorBiometricAuth = (function (exports, core, app) {
             return Promise.resolve({
                 isAvailable: this.biometryType !== exports.BiometryType.none,
                 biometryType: this.biometryType,
-                reason: ''
+                reason: '',
+                code: exports.BiometryErrorType.none,
             });
         }
         async authenticate(options) {
@@ -163,7 +159,8 @@ var capacitorBiometricAuth = (function (exports, core, app) {
             return Promise.resolve({
                 isAvailable: true,
                 biometryType: exports.BiometryType.none,
-                reason: ''
+                reason: '',
+                code: exports.BiometryErrorType.none,
             });
         }
         // eslint-disable-next-line @typescript-eslint/no-unused-vars,@typescript-eslint/no-empty-function
@@ -185,8 +182,6 @@ var capacitorBiometricAuth = (function (exports, core, app) {
     exports.BiometryError = BiometryError;
     exports.getBiometryName = getBiometryName;
 
-    Object.defineProperty(exports, '__esModule', { value: true });
-
     return exports;
 
 })({}, capacitorExports, app);

package/ios/Plugin/Plugin.m

@@ -1,8 +1,6 @@
 #import <Foundation/Foundation.h>
 #import <Capacitor/Capacitor.h>
 
-// Generated by @aparajita/capacitor-native-decorator/make-ios-plugin
-
 CAP_PLUGIN(BiometricAuthNative, "BiometricAuthNative",
   CAP_PLUGIN_METHOD(checkBiometry, CAPPluginReturnPromise);
   CAP_PLUGIN_METHOD(authenticate, CAPPluginReturnPromise);

package/ios/Plugin/Plugin.swift

@@ -7,18 +7,18 @@ private let kMissingFaceIDUsageEntry = "The device supports Face ID, but NSFaceI
 
 @objc(BiometricAuthNative)
 public class BiometricAuthNative: CAPPlugin {
-  let biometryErrorCodeMap: [LAError.Code: String] = [
-    .appCancel: "appCancel",
-    .authenticationFailed: "authenticationFailed",
-    .invalidContext: "invalidContext",
-    .notInteractive: "notInteractive",
-    .passcodeNotSet: "passcodeNotSet",
-    .systemCancel: "systemCancel",
-    .userCancel: "userCancel",
-    .userFallback: "userFallback",
-    .biometryLockout: "biometryLockout",
-    .biometryNotAvailable: "biometryNotAvailable",
-    .biometryNotEnrolled: "biometryNotEnrolled"
+  let biometryErrorCodeMap: [Int: String] = [
+    LAError.appCancel.rawValue: "appCancel",
+    LAError.authenticationFailed.rawValue: "authenticationFailed",
+    LAError.invalidContext.rawValue: "invalidContext",
+    LAError.notInteractive.rawValue: "notInteractive",
+    LAError.passcodeNotSet.rawValue: "passcodeNotSet",
+    LAError.systemCancel.rawValue: "systemCancel",
+    LAError.userCancel.rawValue: "userCancel",
+    LAError.userFallback.rawValue: "userFallback",
+    LAError.biometryLockout.rawValue: "biometryLockout",
+    LAError.biometryNotAvailable.rawValue: "biometryNotAvailable",
+    LAError.biometryNotEnrolled.rawValue: "biometryNotEnrolled",
   ]
 
   var canEvaluatePolicy = true
@@ -31,6 +31,7 @@ public class BiometricAuthNative: CAPPlugin {
     var error: NSError?
     var available = context.canEvaluatePolicy(.deviceOwnerAuthenticationWithBiometrics, error: &error)
     var reason = ""
+    var errorCode = ""
 
     if available, context.biometryType == .faceID {
       // The system may report that biometry is available, but if the type is Face ID
@@ -42,6 +43,7 @@ public class BiometricAuthNative: CAPPlugin {
         available = false
         canEvaluatePolicy = false
         reason = kMissingFaceIDUsageEntry
+        errorCode = biometryErrorCodeMap[LAError.biometryNotAvailable.rawValue] ?? ""
       }
     } else if !available,
               let error = error {
@@ -51,12 +53,15 @@ public class BiometricAuthNative: CAPPlugin {
       if let failureReason = error.localizedFailureReason {
         reason = "\(reason): \(failureReason)"
       }
+
+      errorCode = biometryErrorCodeMap[error.code] ?? biometryErrorCodeMap[LAError.biometryNotAvailable.rawValue] ?? ""
     }
 
     call.resolve([
       "isAvailable": available,
       "biometryType": context.biometryType.rawValue,
-      "reason": reason
+      "reason": reason,
+      "code": errorCode
     ])
   }
 
@@ -72,7 +77,7 @@ public class BiometricAuthNative: CAPPlugin {
     guard canEvaluatePolicy else {
       call.reject(
         kMissingFaceIDUsageEntry,
-        biometryErrorCodeMap[.biometryNotAvailable]
+        biometryErrorCodeMap[LAError.biometryNotAvailable.rawValue]
       )
 
       return
@@ -111,10 +116,10 @@ public class BiometricAuthNative: CAPPlugin {
         call.resolve()
       } else {
         if let policyError = error as? LAError {
-          let code = self.biometryErrorCodeMap[policyError.code]
+          let code = self.biometryErrorCodeMap[policyError.code.rawValue]
           call.reject(policyError.localizedDescription, code)
         } else {
-          call.reject("An unknown error occurred.", self.biometryErrorCodeMap[.authenticationFailed])
+          call.reject("An unknown error occurred.", self.biometryErrorCodeMap[LAError.authenticationFailed.rawValue])
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aparajita/capacitor-biometric-auth",
-  "version": "3.1.4",
+  "version": "5.0.0",
   "description": "Provides access to the native biometric auth APIs for Capacitor apps",
   "author": "Aparajita Fishman",
   "license": "MIT",
@@ -56,46 +56,44 @@
     "@aparajita/eslint-config-base": "^1.1.5",
     "@aparajita/prettier-config": "^1.0.0",
     "@aparajita/swiftly": "^1.0.4",
-    "@capacitor/cli": "^4.0.1",
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
+    "@capacitor/cli": "^5.0.5",
+    "@commitlint/cli": "^17.6.5",
+    "@commitlint/config-conventional": "^17.6.5",
     "@ionic/swiftlint-config": "^1.1.2",
-    "@rollup/plugin-json": "^4.1.0",
-    "@types/node": "^18.6.5",
-    "@typescript-eslint/eslint-plugin": "^5.33.0",
-    "@typescript-eslint/parser": "^5.33.0",
-    "commit-and-tag-version": "^10.0.1",
-    "eslint": "^8.21.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-import-resolver-typescript": "^3.4.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-n": "^15.2.4",
+    "@rollup/plugin-json": "^6.0.0",
+    "@types/node": "^20.3.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.11",
+    "@typescript-eslint/parser": "^5.59.11",
+    "commit-and-tag-version": "^11.2.1",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.0.0",
-    "husky": "^8.0.1",
-    "nodemon": "^2.0.19",
-    "prettier": "^2.7.1",
-    "prettier-plugin-java": "^1.6.2",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.77.2",
-    "swiftlint": "^1.0.1",
-    "typescript": "~4.7.4"
+    "eslint-plugin-promise": "^6.1.1",
+    "nodemon": "^2.0.22",
+    "prettier": "^2.8.8",
+    "prettier-plugin-java": "^2.1.0",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.25.1",
+    "swiftlint": "^1.0.2",
+    "typescript": "~5.1.3"
   },
   "dependencies": {
-    "@capacitor/android": "^4.0.1",
-    "@capacitor/app": "^4.0.1",
-    "@capacitor/core": "^4.0.1",
-    "@capacitor/ios": "^4.0.1"
+    "@capacitor/android": "^5.0.5",
+    "@capacitor/app": "^5.0.3",
+    "@capacitor/core": "^5.0.5",
+    "@capacitor/ios": "^5.0.5"
   },
   "scripts": {
     "clean": "rimraf dist",
-    "extract-info": "node scripts/extractPackageInfo.js",
     "lint.eslint": "eslint --fix --cache --ext .js,.cjs,.mjs,.ts --max-warnings 0",
     "lint.prettier": "prettier --write --cache --list-different",
     "lint.tsc": "tsc --noEmit",
     "lint": "pnpm lint.eslint . && pnpm lint.prettier . && pnpm lint.tsc",
-    "prebuilder": "pnpm clean && pnpm extract-info",
+    "prebuilder": "pnpm clean",
     "builder": "tsc ${SOURCE_MAP:-} && rollup -c rollup.config.mjs",
     "prebuild": "pnpm lint",
     "build": "pnpm builder",

package/dist/esm/info.json

@@ -1,4 +0,0 @@
-{
-    "name": "@aparajita/capacitor-biometric-auth",
-    "version": "3.1.4"
-}