@aparajita/capacitor-biometric-auth 4.0.0 → 5.0.1

package/README.md

@@ -2,9 +2,9 @@
 
 # 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 4](https://capacitorjs.com) provides access to native biometry on iOS and Android. It supports every type of biometry and every configuration option on both platforms. In addition, biometry is simulated on the web so you can test your logic without making any changes to your code.
+This plugin for [Capacitor 5](https://capacitorjs.com) provides access to native biometry on iOS and Android. It supports every type of biometry and every configuration option on both platforms. In addition, biometry is simulated on the web so you can test your logic without making any changes to your code.
 
-👉 **NOTE:** This plugin only works with Capacitor 4. If you are upgrading from the Capacitor 2 version, note that the plugin name has changed to `BiometricAuth`.
+👉 **NOTE:** This plugin only works with Capacitor 5. If you are upgrading from the Capacitor 2 version, note that the plugin name has changed to `BiometricAuth`.
 
 🛑 **BREAKING CHANGE:** If you are upgrading from a version prior to 3.0.0, please note that `androidMaxAttempts` is no longer supported. See the documentation for [`authenticate()`](#authenticate) for more information.
 
@@ -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.
 

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/dist/esm/definitions.d.ts

@@ -163,7 +163,7 @@ export interface CheckBiometryResult {
 /**
  * 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/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

@@ -13,7 +13,7 @@ export class BiometricAuthNative extends BiometricAuthBase {
             isAvailable: true,
             biometryType: BiometryType.none,
             reason: '',
-            code: BiometryErrorType.none
+            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

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

package/dist/plugin.cjs.js

@@ -3,11 +3,6 @@
 var core = require('@capacitor/core');
 var app = require('@capacitor/app');
 
-var info = {
-  name: "@aparajita/capacitor-biometric-auth",
-  version: "4.0.0"
-};
-
 exports.BiometryType = void 0;
 (function (BiometryType) {
     /**
@@ -72,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.
@@ -82,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 +109,7 @@ class BiometricAuthWeb extends BiometricAuthBase {
             isAvailable: this.biometryType !== exports.BiometryType.none,
             biometryType: this.biometryType,
             reason: '',
-            code: exports.BiometryErrorType.none
+            code: exports.BiometryErrorType.none,
         });
     }
     async authenticate(options) {
@@ -168,7 +162,7 @@ class BiometricAuthNative extends BiometricAuthBase {
             isAvailable: true,
             biometryType: exports.BiometryType.none,
             reason: '',
-            code: exports.BiometryErrorType.none
+            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: "4.0.0"
-    };
-
     exports.BiometryType = void 0;
     (function (BiometryType) {
         /**
@@ -70,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.
@@ -80,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
@@ -113,7 +107,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 isAvailable: this.biometryType !== exports.BiometryType.none,
                 biometryType: this.biometryType,
                 reason: '',
-                code: exports.BiometryErrorType.none
+                code: exports.BiometryErrorType.none,
             });
         }
         async authenticate(options) {
@@ -166,7 +160,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 isAvailable: true,
                 biometryType: exports.BiometryType.none,
                 reason: '',
-                code: exports.BiometryErrorType.none
+                code: exports.BiometryErrorType.none,
             });
         }
         // eslint-disable-next-line @typescript-eslint/no-unused-vars,@typescript-eslint/no-empty-function

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aparajita/capacitor-biometric-auth",
-  "version": "4.0.0",
+  "version": "5.0.1",
   "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.7.2",
-    "@commitlint/cli": "^17.5.1",
-    "@commitlint/config-conventional": "^17.4.4",
+    "@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": "^6.0.0",
-    "@types/node": "^18.15.11",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
-    "commit-and-tag-version": "^11.2.0",
-    "eslint": "^8.37.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.0.0",
-    "eslint-import-resolver-typescript": "^3.5.4",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.1.1",
-    "husky": "^8.0.3",
     "nodemon": "^2.0.22",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "prettier-plugin-java": "^2.1.0",
-    "rimraf": "^4.4.1",
-    "rollup": "^3.20.2",
-    "swiftlint": "^1.0.1",
-    "typescript": "~4.7.4"
+    "rimraf": "^5.0.1",
+    "rollup": "^3.25.1",
+    "swiftlint": "^1.0.2",
+    "typescript": "~5.1.3"
   },
   "dependencies": {
-    "@capacitor/android": "^4.7.2",
-    "@capacitor/app": "^4.1.1",
-    "@capacitor/core": "^4.7.2",
-    "@capacitor/ios": "^4.7.2"
+    "@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": "4.0.0"
-}