@aparajita/capacitor-biometric-auth 3.1.3 → 3.1.4

package/README.md

@@ -28,6 +28,8 @@ Not using [pnpm](https://pnpm.js.org/)? You owe it to yourself to give it a try.
 
 The API is extensively documented in the [TypeScript definitions file](src/definitions.ts). There is also (somewhat incomplete auto-generated) documentation [below](#api). For a complete example of how to use this plugin in practice, see the [demo app](https://github.com/aparajita/capacitor-biometric-auth-demo).
 
+> **NOTE:** Your Android app must use a base theme named "AppTheme".
+
 ### 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.
@@ -107,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>Android imposes a limit of 5 failed attempts. If `allowDeviceCredential` is `true`, the user will then be presented with a device credential prompt. If `allowDeviceCredential` is `false`, `authenticate()` will reject with a `BiometryErrorType` of `biometryLockout`, after which the user will have to wait 30 seconds 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 `BiometryErrorType` of `biometryLockout`, after which the user will have to wait the system-defined length of time before being allowed to authenticate again.
 
 | Param   | Type                                                   |
 | :------ | :----------------------------------------------------- |

package/android/src/main/AndroidManifest.xml

@@ -5,7 +5,7 @@
     <application>
       <activity
         android:name=".AuthActivity"
-        android:label="@string/title_activity_auth_acitivy"
+        android:label="@string/title_activity_auth_activity"
         android:theme="@style/AppTheme.Transparent"/>
     </application>
 

package/android/src/main/res/values/strings.xml

@@ -1,12 +1,3 @@
 <resources>
-    <string name="my_string">Just a simple string</string>
-    <string name="title_activity_auth_acitivy">AuthAcitivy</string>
-    <!-- Strings used for fragments for navigation -->
-    <string name="first_fragment_label">First Fragment</string>
-    <string name="second_fragment_label">Second Fragment</string>
-    <string name="next">Next</string>
-    <string name="previous">Previous</string>
-
-    <string name="hello_first_fragment">Hello first fragment</string>
-    <string name="hello_second_fragment">Hello second fragment. Arg: %1$s</string>
+    <string name="title_activity_auth_activity">AuthActivity</string>
 </resources>

package/android/src/main/res/values/styles.xml

@@ -1,11 +1,5 @@
 <resources>
 
-
-    <style name="AppTheme.NoActionBar">
-        <item name="windowActionBar">false</item>
-        <item name="windowNoTitle">true</item>
-    </style>
-
     <style name="AppTheme.AppBarOverlay" parent="ThemeOverlay.AppCompat.Dark.ActionBar" />
 
     <style name="AppTheme.PopupOverlay" parent="ThemeOverlay.AppCompat.Light" />

package/dist/esm/definitions.d.ts

@@ -173,11 +173,13 @@ export interface BiometricAuthPlugin extends WebPlugin {
      *
      * https://developer.apple.com/documentation/localauthentication/lapolicy/deviceownerauthenticationwithbiometrics
      *
-     * Android imposes a limit of 5 failed attempts. If `allowDeviceCredential` is
-     * `true`, the user will then be presented with a device credential prompt.
-     * If `allowDeviceCredential` is `false`, `authenticate()` will reject with
-     * a `BiometryErrorType` of `biometryLockout`, after which the user will have
-     * to wait 30 seconds before being allowed to authenticate again.
+     * 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.
      *
      * @rejects {BiometryError}
      */

package/dist/esm/info.json

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

package/dist/plugin.cjs.js

@@ -7,7 +7,7 @@ var app = require('@capacitor/app');
 
 var info = {
   name: "@aparajita/capacitor-biometric-auth",
-  version: "3.1.3"
+  version: "3.1.4"
 };
 
 exports.BiometryType = void 0;

package/dist/plugin.js

@@ -3,7 +3,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
 
     var info = {
       name: "@aparajita/capacitor-biometric-auth",
-      version: "3.1.3"
+      version: "3.1.4"
     };
 
     exports.BiometryType = void 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aparajita/capacitor-biometric-auth",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "description": "Provides access to the native biometric auth APIs for Capacitor apps",
   "author": "Aparajita Fishman",
   "license": "MIT",

package/android/src/main/res/layout/bridge_layout_main.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:app="http://schemas.android.com/apk/res-auto"
-    xmlns:tools="http://schemas.android.com/tools"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"
-    tools:context="com.getcapacitor.BridgeActivity"
-    >
-
-    <WebView
-        android:id="@+id/webview"
-        android:layout_width="fill_parent"
-        android:layout_height="fill_parent" />
-
-</androidx.coordinatorlayout.widget.CoordinatorLayout>

package/android/src/main/res/navigation/nav_graph.xml

@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<navigation xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:app="http://schemas.android.com/apk/res-auto"
-    xmlns:tools="http://schemas.android.com/tools"
-    android:id="@+id/nav_graph"
-    app:startDestination="@id/FirstFragment">
-
-    <fragment
-        android:id="@+id/FirstFragment"
-        android:name="com.epicshaggy.biometric.FirstFragment"
-        android:label="@string/first_fragment_label"
-        tools:layout="@layout/fragment_first">
-
-        <action
-            android:id="@+id/action_FirstFragment_to_SecondFragment"
-            app:destination="@id/SecondFragment" />
-    </fragment>
-    <fragment
-        android:id="@+id/SecondFragment"
-        android:name="com.epicshaggy.biometric.SecondFragment"
-        android:label="@string/second_fragment_label"
-        tools:layout="@layout/fragment_second">
-
-        <action
-            android:id="@+id/action_SecondFragment_to_FirstFragment"
-            app:destination="@id/FirstFragment" />
-    </fragment>
-</navigation>

package/android/src/main/res/values/colors.xml

@@ -1,3 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<resources>
-</resources>

package/android/src/main/res/values/dimens.xml

@@ -1,3 +0,0 @@
-<resources>
-    <dimen name="fab_margin">16dp</dimen>
-</resources>