@aparajita/capacitor-biometric-auth 7.2.0 → 8.0.0

package/README.md

@@ -2,13 +2,18 @@
 
 # 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 5](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 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.
 
 🛑 **BREAKING CHANGES:**
 
 - If you are upgrading from a version prior to 6.0.0, please note that [`authenticate()`](#authenticate) now throws an instance of `BiometryError`, and `BiometryError.code` is now typed as [`BiometryErrorType`](#biometryerrortype).
+
 - 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 [`addResumeListener`](#addresumelistener) now always returns a Promise and must be awaited.
+
 ## Installation
 
 ```sh

package/android/build.gradle

@@ -11,7 +11,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.0.2'
+        classpath 'com.android.tools.build:gradle:8.2.1'
     }
 }
 
@@ -19,10 +19,10 @@ apply plugin: 'com.android.library'
 
 android {
     namespace "com.aparajita.capacitor.biometricauth"
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

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

@@ -270,7 +270,7 @@ public class BiometricAuthNative extends Plugin {
     );
     intent.putExtra(BIOMETRIC_STRENGTH, getAuthenticatorFromCall(call));
 
-    if (call.hasOption(CONFIRMATION_REQUIRED)) {
+    if (call.getBoolean(CONFIRMATION_REQUIRED, true) != null) {
       intent.putExtra(
         CONFIRMATION_REQUIRED,
         call.getBoolean(CONFIRMATION_REQUIRED, true)

package/dist/esm/base.d.ts

@@ -8,5 +8,5 @@ export declare abstract class BiometricAuthBase extends WebPlugin implements Bio
     abstract setDeviceIsSecure(isSecure: boolean): Promise<void>;
     authenticate(options?: AuthenticateOptions): Promise<void>;
     protected abstract internalAuthenticate(options?: AuthenticateOptions): Promise<void>;
-    addResumeListener(listener: ResumeListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addResumeListener(listener: ResumeListener): Promise<PluginListenerHandle>;
 }

package/dist/esm/base.js

@@ -10,16 +10,14 @@ export class BiometricAuthBase extends WebPlugin {
             // 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, 
-                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we are converting from ExceptionCode to BiometryErrorType
-                error.code);
+                throw new BiometryError(error.message, error.code);
             }
             else {
                 throw error;
             }
         }
     }
-    addResumeListener(listener) {
+    async addResumeListener(listener) {
         return App.addListener('appStateChange', ({ isActive }) => {
             if (isActive) {
                 this.checkBiometry()

package/dist/esm/native.js

@@ -1,5 +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
 export class BiometricAuthNative extends BiometricAuthBase {
     constructor(capProxy) {
@@ -12,12 +13,11 @@ 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/consistent-type-assertions
         const proxy = capProxy;
         /* eslint-disable @typescript-eslint/unbound-method */
         this.checkBiometry = proxy.checkBiometry;
         this.internalAuthenticate = proxy.internalAuthenticate;
-        /* eslint-enable */
+        /* eslint-enable @typescript-eslint/unbound-method */
     }
     // @native
     async checkBiometry() {
@@ -36,28 +36,17 @@ export class BiometricAuthNative extends BiometricAuthBase {
     }
     // @native
     // On native platforms, this will present the native authentication UI.
-    async internalAuthenticate(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    options) { }
+    async internalAuthenticate(options) { }
     // Web only, used for simulating biometric authentication.
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setBiometryType(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type) {
-        throw this.unimplemented('setBiometryType() is web only');
+    async setBiometryType(type) {
+        console.warn('setBiometryType() is web only');
     }
     // Web only, used for simulating biometry enrollment.
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setBiometryIsEnrolled(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    enrolled) {
-        throw this.unimplemented('setBiometryEnrolled() is web only');
+    async setBiometryIsEnrolled(enrolled) {
+        console.warn('setBiometryEnrolled() is web only');
     }
     // Web only, used for simulating device security.
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setDeviceIsSecure(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    isSecure) {
-        throw this.unimplemented('setDeviceIsSecure() is web only');
+    async setDeviceIsSecure(isSecure) {
+        console.warn('setDeviceIsSecure() is web only');
     }
 }

package/dist/esm/web.js

@@ -102,9 +102,7 @@ export class BiometricAuthWeb extends BiometricAuthBase {
             for (let i = 0; i < types.length; i++) {
                 // eslint-disable-next-line no-prototype-builtins
                 if (BiometryType.hasOwnProperty(types[i])) {
-                    const biometryType = 
-                    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-                    BiometryType[types[i]];
+                    const biometryType = BiometryType[types[i]];
                     if (this.biometryType === BiometryType.none) {
                         this.biometryTypes = [];
                     }
@@ -131,6 +129,5 @@ export class BiometricAuthWeb extends BiometricAuthBase {
     }
 }
 function isBiometryTypes(value) {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return Object.values(BiometryType).includes(value[0]);
 }

package/dist/plugin.cjs.js

@@ -107,16 +107,14 @@ class BiometricAuthBase extends core.WebPlugin {
             // error will be an instance of CapacitorException on native platforms,
             // an instance of BiometryError on the web.
             if (error instanceof core.CapacitorException) {
-                throw new BiometryError(error.message, 
-                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we are converting from ExceptionCode to BiometryErrorType
-                error.code);
+                throw new BiometryError(error.message, error.code);
             }
             else {
                 throw error;
             }
         }
     }
-    addResumeListener(listener) {
+    async addResumeListener(listener) {
         return app.App.addListener('appStateChange', ({ isActive }) => {
             if (isActive) {
                 this.checkBiometry()
@@ -230,9 +228,7 @@ class BiometricAuthWeb extends BiometricAuthBase {
             for (let i = 0; i < types.length; i++) {
                 // eslint-disable-next-line no-prototype-builtins
                 if (exports.BiometryType.hasOwnProperty(types[i])) {
-                    const biometryType = 
-                    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-                    exports.BiometryType[types[i]];
+                    const biometryType = exports.BiometryType[types[i]];
                     if (this.biometryType === exports.BiometryType.none) {
                         this.biometryTypes = [];
                     }
@@ -259,7 +255,6 @@ class BiometricAuthWeb extends BiometricAuthBase {
     }
 }
 function isBiometryTypes(value) {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return Object.values(exports.BiometryType).includes(value[0]);
 }
 
@@ -268,6 +263,7 @@ var web = /*#__PURE__*/Object.freeze({
     BiometricAuthWeb: BiometricAuthWeb
 });
 
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/require-await */
 // eslint-disable-next-line import/prefer-default-export
 class BiometricAuthNative extends BiometricAuthBase {
     constructor(capProxy) {
@@ -280,12 +276,11 @@ 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/consistent-type-assertions
         const proxy = capProxy;
         /* eslint-disable @typescript-eslint/unbound-method */
         this.checkBiometry = proxy.checkBiometry;
         this.internalAuthenticate = proxy.internalAuthenticate;
-        /* eslint-enable */
+        /* eslint-enable @typescript-eslint/unbound-method */
     }
     // @native
     async checkBiometry() {
@@ -304,29 +299,18 @@ class BiometricAuthNative extends BiometricAuthBase {
     }
     // @native
     // On native platforms, this will present the native authentication UI.
-    async internalAuthenticate(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    options) { }
+    async internalAuthenticate(options) { }
     // Web only, used for simulating biometric authentication.
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setBiometryType(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type) {
-        throw this.unimplemented('setBiometryType() is web only');
+    async setBiometryType(type) {
+        console.warn('setBiometryType() is web only');
     }
     // Web only, used for simulating biometry enrollment.
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setBiometryIsEnrolled(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    enrolled) {
-        throw this.unimplemented('setBiometryEnrolled() is web only');
+    async setBiometryIsEnrolled(enrolled) {
+        console.warn('setBiometryEnrolled() is web only');
     }
     // Web only, used for simulating device security.
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setDeviceIsSecure(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    isSecure) {
-        throw this.unimplemented('setDeviceIsSecure() is web only');
+    async setDeviceIsSecure(isSecure) {
+        console.warn('setDeviceIsSecure() is web only');
     }
 }
 

package/dist/plugin.js

@@ -105,16 +105,14 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 // error will be an instance of CapacitorException on native platforms,
                 // an instance of BiometryError on the web.
                 if (error instanceof core.CapacitorException) {
-                    throw new BiometryError(error.message, 
-                    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we are converting from ExceptionCode to BiometryErrorType
-                    error.code);
+                    throw new BiometryError(error.message, error.code);
                 }
                 else {
                     throw error;
                 }
             }
         }
-        addResumeListener(listener) {
+        async addResumeListener(listener) {
             return app.App.addListener('appStateChange', ({ isActive }) => {
                 if (isActive) {
                     this.checkBiometry()
@@ -228,9 +226,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 for (let i = 0; i < types.length; i++) {
                     // eslint-disable-next-line no-prototype-builtins
                     if (exports.BiometryType.hasOwnProperty(types[i])) {
-                        const biometryType = 
-                        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-                        exports.BiometryType[types[i]];
+                        const biometryType = exports.BiometryType[types[i]];
                         if (this.biometryType === exports.BiometryType.none) {
                             this.biometryTypes = [];
                         }
@@ -257,7 +253,6 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         }
     }
     function isBiometryTypes(value) {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         return Object.values(exports.BiometryType).includes(value[0]);
     }
 
@@ -266,6 +261,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         BiometricAuthWeb: BiometricAuthWeb
     });
 
+    /* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/require-await */
     // eslint-disable-next-line import/prefer-default-export
     class BiometricAuthNative extends BiometricAuthBase {
         constructor(capProxy) {
@@ -278,12 +274,11 @@ var capacitorBiometricAuth = (function (exports, core, app) {
               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/consistent-type-assertions
             const proxy = capProxy;
             /* eslint-disable @typescript-eslint/unbound-method */
             this.checkBiometry = proxy.checkBiometry;
             this.internalAuthenticate = proxy.internalAuthenticate;
-            /* eslint-enable */
+            /* eslint-enable @typescript-eslint/unbound-method */
         }
         // @native
         async checkBiometry() {
@@ -302,29 +297,18 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         }
         // @native
         // On native platforms, this will present the native authentication UI.
-        async internalAuthenticate(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        options) { }
+        async internalAuthenticate(options) { }
         // Web only, used for simulating biometric authentication.
-        // eslint-disable-next-line @typescript-eslint/require-await
-        async setBiometryType(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        type) {
-            throw this.unimplemented('setBiometryType() is web only');
+        async setBiometryType(type) {
+            console.warn('setBiometryType() is web only');
         }
         // Web only, used for simulating biometry enrollment.
-        // eslint-disable-next-line @typescript-eslint/require-await
-        async setBiometryIsEnrolled(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        enrolled) {
-            throw this.unimplemented('setBiometryEnrolled() is web only');
+        async setBiometryIsEnrolled(enrolled) {
+            console.warn('setBiometryEnrolled() is web only');
         }
         // Web only, used for simulating device security.
-        // eslint-disable-next-line @typescript-eslint/require-await
-        async setDeviceIsSecure(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        isSecure) {
-            throw this.unimplemented('setDeviceIsSecure() is web only');
+        async setDeviceIsSecure(isSecure) {
+            console.warn('setDeviceIsSecure() is web only');
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aparajita/capacitor-biometric-auth",
-  "version": "7.2.0",
+  "version": "8.0.0",
   "description": "Provides access to the native biometric auth & device security APIs for Capacitor apps",
   "author": "Aparajita Fishman",
   "license": "MIT",
@@ -57,15 +57,15 @@
     "@aparajita/eslint-config-base": "^1.1.6",
     "@aparajita/prettier-config": "^2.0.0",
     "@aparajita/swiftly": "^1.0.4",
-    "@capacitor/cli": "^5.7.4",
-    "@commitlint/cli": "^19.2.1",
-    "@commitlint/config-conventional": "^19.1.0",
+    "@capacitor/cli": "^6.0.0",
+    "@commitlint/cli": "^19.2.2",
+    "@commitlint/config-conventional": "^19.2.2",
     "@ionic/swiftlint-config": "^1.1.2",
     "@rollup/plugin-json": "^6.1.0",
-    "@types/node": "^20.12.4",
-    "@typescript-eslint/eslint-plugin": "^7.5.0",
-    "@typescript-eslint/parser": "^7.5.0",
-    "commit-and-tag-version": "^12.2.0",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
+    "commit-and-tag-version": "^12.4.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^17.1.0",
@@ -77,16 +77,16 @@
     "prettier": "^3.2.5",
     "prettier-plugin-java": "^2.6.0",
     "rimraf": "^5.0.5",
-    "rollup": "^4.14.0",
+    "rollup": "^4.16.1",
     "simple-git-hooks": "^2.11.1",
     "swiftlint": "^1.0.2",
-    "typescript": "~5.4.3"
+    "typescript": "~5.4.5"
   },
   "dependencies": {
-    "@capacitor/android": "^5.7.4",
-    "@capacitor/app": "^5.0.7",
-    "@capacitor/core": "^5.7.4",
-    "@capacitor/ios": "^5.7.4"
+    "@capacitor/android": "^6.0.0",
+    "@capacitor/app": "^6.0.0",
+    "@capacitor/core": "^6.0.0",
+    "@capacitor/ios": "^6.0.0"
   },
   "scripts": {
     "clean": "rimraf dist",