@aparajita/capacitor-biometric-auth 1.0.7 → 2.0.0

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

@@ -0,0 +1,262 @@
+package com.aparajita.capacitor.biometricauth;
+
+import android.annotation.SuppressLint;
+import android.app.Activity;
+import android.content.Intent;
+import android.content.pm.PackageManager;
+import androidx.activity.result.ActivityResult;
+import androidx.biometric.BiometricManager;
+import androidx.biometric.BiometricPrompt;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.ActivityCallback;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import java.util.HashMap;
+
+@SuppressLint("RestrictedApi")
+@CapacitorPlugin(name = "BiometricAuth")
+public class BiometricAuth extends Plugin {
+
+  public static final String RESULT_TYPE = "type";
+  public static final String RESULT_ERROR_CODE = "errorCode";
+  public static final String RESULT_ERROR_MESSAGE = "errorMessage";
+  public static final String TITLE = "androidTitle";
+  public static final String SUBTITLE = "androidSubtitle";
+  public static final String REASON = "reason";
+  public static final String CANCEL_TITLE = "cancelTitle";
+  public static final String DEVICE_CREDENTIAL = "allowDeviceCredential";
+  public static final String MAX_ATTEMPTS = "androidMaxAttempts";
+  public static final int DEFAULT_MAX_ATTEMPTS = 3;
+  // Error code when biometry is not recognized
+  public static final String BIOMETRIC_FAILURE = "authenticationFailed";
+  // Maps biometry error numbers to string error codes
+  private static final HashMap<Integer, String> biometryErrorCodeMap;
+  private static final HashMap<BiometryType, String> biometryNameMap;
+  private static final String INVALID_CONTEXT_ERROR = "invalidContext";
+  public static String RESULT_EXTRA_PREFIX;
+
+  static {
+    biometryErrorCodeMap = new HashMap<>();
+    biometryErrorCodeMap.put(BiometricPrompt.ERROR_CANCELED, "systemCancel");
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_HW_NOT_PRESENT,
+      "biometryNotAvailable"
+    );
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_HW_UNAVAILABLE,
+      "biometryNotAvailable"
+    );
+    biometryErrorCodeMap.put(BiometricPrompt.ERROR_LOCKOUT, "biometryLockout");
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_LOCKOUT_PERMANENT,
+      "biometryLockout"
+    );
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_NEGATIVE_BUTTON,
+      "userCancel"
+    );
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_NO_BIOMETRICS,
+      "biometryNotEnrolled"
+    );
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_NO_DEVICE_CREDENTIAL,
+      "noDeviceCredential"
+    );
+    biometryErrorCodeMap.put(BiometricPrompt.ERROR_NO_SPACE, "systemCancel");
+    biometryErrorCodeMap.put(BiometricPrompt.ERROR_TIMEOUT, "systemCancel");
+    biometryErrorCodeMap.put(
+      BiometricPrompt.ERROR_UNABLE_TO_PROCESS,
+      "systemCancel"
+    );
+    biometryErrorCodeMap.put(BiometricPrompt.ERROR_USER_CANCELED, "userCancel");
+    biometryErrorCodeMap.put(BiometricPrompt.ERROR_VENDOR, "systemCancel");
+  }
+
+  static {
+    biometryNameMap = new HashMap<>();
+    biometryNameMap.put(BiometryType.NONE, "No Authentication");
+    biometryNameMap.put(BiometryType.FINGERPRINT, "Fingerprint Authentication");
+    biometryNameMap.put(BiometryType.FACE, "Face Authentication");
+    biometryNameMap.put(BiometryType.IRIS, "Iris Authentication");
+  }
+
+  private BiometryType biometryType;
+
+  /**
+   * Check the device's availability and type of biometric authentication.
+   */
+  @PluginMethod
+  public void checkBiometry(PluginCall call) {
+    BiometricManager manager = BiometricManager.from(getContext());
+
+    int result = manager.canAuthenticate();
+
+    JSObject ret = new JSObject();
+    ret.put("isAvailable", result == BiometricManager.BIOMETRIC_SUCCESS);
+    biometryType = getDeviceBiometryType();
+    ret.put("biometryType", biometryType.getType());
+
+    String reason = "";
+
+    switch (result) {
+      case BiometricManager.BIOMETRIC_SUCCESS:
+        break;
+      case BiometricManager.BIOMETRIC_ERROR_HW_UNAVAILABLE:
+        reason = "Biometry hardware is present, but currently unavailable.";
+        break;
+      case BiometricManager.BIOMETRIC_ERROR_NONE_ENROLLED:
+        reason = "The user does not have any biometrics enrolled.";
+        break;
+      case BiometricManager.BIOMETRIC_ERROR_NO_HARDWARE:
+        reason = "There is no biometric hardware on this device.";
+        break;
+    }
+
+    ret.put("reason", reason);
+    call.resolve(ret);
+  }
+
+  private BiometryType getDeviceBiometryType() {
+    PackageManager manager = getContext().getPackageManager();
+
+    if (manager.hasSystemFeature(PackageManager.FEATURE_FINGERPRINT)) {
+      return BiometryType.FINGERPRINT;
+    }
+
+    if (manager.hasSystemFeature(PackageManager.FEATURE_FACE)) {
+      return BiometryType.FACE;
+    }
+
+    if (manager.hasSystemFeature(PackageManager.FEATURE_IRIS)) {
+      return BiometryType.IRIS;
+    }
+
+    return BiometryType.NONE;
+  }
+
+  /**
+   * Prompt the user for biometric authentication.
+   */
+  @PluginMethod
+  public void authenticate(final PluginCall call) {
+    // The result of an intent is supposed to have the package name as a prefix
+    RESULT_EXTRA_PREFIX = getContext().getPackageName() + ".";
+
+    Intent intent = new Intent(getContext(), AuthActivity.class);
+
+    // Pass the options to the activity
+    intent.putExtra(
+      TITLE,
+      call.getString(TITLE, biometryNameMap.get(biometryType))
+    );
+    intent.putExtra(SUBTITLE, call.getString(SUBTITLE));
+    intent.putExtra(REASON, call.getString(REASON));
+    intent.putExtra(CANCEL_TITLE, call.getString(CANCEL_TITLE));
+    intent.putExtra(
+      DEVICE_CREDENTIAL,
+      call.getBoolean(DEVICE_CREDENTIAL, false)
+    );
+
+    // Just in case the developer does something dumb like using a number < 1...
+    Integer maxAttemptsConfig = call.getInt(MAX_ATTEMPTS, DEFAULT_MAX_ATTEMPTS);
+    int maxAttempts = Math.max(
+      maxAttemptsConfig == null ? 0 : maxAttemptsConfig,
+      1
+    );
+    intent.putExtra(MAX_ATTEMPTS, maxAttempts);
+
+    startActivityForResult(call, intent, "authenticateResult");
+  }
+
+  @ActivityCallback
+  protected void authenticateResult(PluginCall call, ActivityResult result) {
+    int resultCode = result.getResultCode();
+
+    // If the system canceled the activity, we might get RESULT_CANCELED in resultCode.
+    // In that case return that immediately, because there won't be any data.
+    if (resultCode == Activity.RESULT_CANCELED) {
+      call.reject(
+        "The system canceled authentication",
+        biometryErrorCodeMap.get(BiometricPrompt.ERROR_CANCELED)
+      );
+      return;
+    }
+
+    // Convert the string result type to an enum
+    Intent data = result.getData();
+    String resultTypeName = null;
+
+    if (data != null) {
+      resultTypeName =
+        data.getStringExtra(RESULT_EXTRA_PREFIX + BiometricAuth.RESULT_TYPE);
+    }
+
+    if (resultTypeName == null) {
+      call.reject(
+        "Missing data in the result of the activity",
+        INVALID_CONTEXT_ERROR
+      );
+      return;
+    }
+
+    BiometryResultType resultType;
+
+    try {
+      resultType = BiometryResultType.valueOf(resultTypeName);
+    } catch (IllegalArgumentException e) {
+      call.reject(
+        "Invalid data in the result of the activity",
+        INVALID_CONTEXT_ERROR
+      );
+      return;
+    }
+
+    int errorCode = data.getIntExtra(
+      RESULT_EXTRA_PREFIX + BiometricAuth.RESULT_ERROR_CODE,
+      0
+    );
+    String errorMessage = data.getStringExtra(
+      RESULT_EXTRA_PREFIX + BiometricAuth.RESULT_ERROR_MESSAGE
+    );
+
+    switch (resultType) {
+      case SUCCESS:
+        call.resolve();
+        break;
+      case FAILURE:
+        // Biometry was successfully presented but was not recognized
+        call.reject(errorMessage, BIOMETRIC_FAILURE);
+        break;
+      case ERROR:
+        // The user cancelled, the system cancelled, or some error occurred.
+        // If the user cancelled, errorMessage is the text of the "negative" button,
+        // which is not especially descriptive.
+        if (errorCode == BiometricPrompt.ERROR_NEGATIVE_BUTTON) {
+          errorMessage = "Cancel button was pressed";
+        }
+
+        call.reject(errorMessage, biometryErrorCodeMap.get(errorCode));
+        break;
+    }
+  }
+
+  enum BiometryType {
+    NONE(0),
+    FINGERPRINT(3),
+    FACE(4),
+    IRIS(5);
+
+    private final int type;
+
+    BiometryType(int type) {
+      this.type = type;
+    }
+
+    public int getType() {
+      return this.type;
+    }
+  }
+}

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

@@ -1,7 +1,7 @@
 package com.aparajita.capacitor.biometricauth;
 
 public enum BiometryResultType {
-    SUCCESS,
-    FAILURE,
-    ERROR
+  SUCCESS,
+  FAILURE,
+  ERROR
 }

package/dist/esm/definitions.d.ts

@@ -1,9 +1,5 @@
-declare module '@capacitor/core' {
-    interface PluginRegistry {
-        WSBiometricAuth: WSBiometricAuthPlugin;
-    }
-}
-import { PluginResultError } from '@capacitor/core';
+import type { DecoratedNativePlugin } from '@aparajita/capacitor-native-decorator';
+import type { PluginListenerHandle, PluginResultError } from '@capacitor/core';
 export declare enum BiometryType {
     /**
      * No biometry is available
@@ -32,8 +28,7 @@ export declare enum BiometryType {
 }
 export interface AuthenticateOptions {
     /**
-     * The reason for requesting authentication. Displays in the authentication dialog presented to the user.
-     * If not supplied, a default message is displayed.
+     * The reason for requesting authentication. Displays in the authentication dialog presented to the user. If not supplied, a default message is displayed.
      */
     reason?: string;
     /**
@@ -53,27 +48,27 @@ export interface AuthenticateOptions {
      * Default: "Cancel"
      */
     cancelTitle?: string;
-    /***
+    /**
      * If true, allows for authentication using device unlock credentials. Default is false.
      *
      * iOS:
      * If biometry is available, enrolled, and not disabled, the system uses that first.
-     * After the first Touch ID failure or second Face ID failure, if iosFallbackTitle
+     * After the first Touch ID failure or second Face ID failure, if `iosFallbackTitle`
      * is not an empty string, a fallback button appears in the authentication dialog.
      * If the user taps the fallback button, the system prompts the user for the device
-     * passcode or the user’s password. If iosFallbackTitle is an empty string, no
+     * passcode or the user’s password. If `iosFallbackTitle` is an empty string, no
      * fallback button will appear.
      *
      * If biometry is not available, enrolled and enabled, and a passcode is set,
      * the system immediately prompts the user for the device passcode or user’s password.
-     * Authentication fails with the error code passcodeNotSet if the device passcode isn’t enabled.
+     * Authentication fails with the error code `passcodeNotSet` if the device passcode isn’t enabled.
      *
-     * If a passcode is not set on the device, a passcodeNotSet error is returned.
+     * If a passcode is not set on the device, a `passcodeNotSet` error is returned.
      *
      * The system disables passcode authentication after 6 unsuccessful attempts, with progressively
      * increasing delays between attempts.
      *
-     * The title of the fallback button may be customized by setting iosFallbackTitle to
+     * The title of the fallback button may be customized by setting `iosFallbackTitle` to
      * a non-empty string.
      *
      * Android:
@@ -88,12 +83,12 @@ export interface AuthenticateOptions {
      * — for example, because the system doesn’t recognize the presented finger,
      * or after several failed attempts to recognize the user’s face.
      *
-     * If allowDeviceCredential is false, tapping this button dismisses the
+     * If `allowDeviceCredential` is false, tapping this button dismisses the
      * authentication dialog and returns the error code userFallback. If undefined,
      * the localized systetm default title is used. Passing an empty string
      * hides the fallback button completely.
      *
-     * If allowDeviceCredential is true and this is undefined,
+     * If `allowDeviceCredential` is true and this is undefined,
      * the localized system default title is used.
      */
     iosFallbackTitle?: string;
@@ -107,12 +102,12 @@ export interface AuthenticateOptions {
     androidSubtitle?: string;
     /**
      * The maximum number of failed biometric verification attempts before
-     * returning BiometryError.authenticationFailed. The default is 3.
+     * returning `BiometryError.authenticationFailed`. The default is 3.
      */
     androidMaxAttempts?: number;
 }
 /**
- * If the authenticate() method throws an exception, the error object
+ * If the `authenticate()` method throws an exception, the error object
  * contains a .code property which will contain one of these strings,
  * indicating what the error was.
  *
@@ -158,42 +153,39 @@ export interface CheckBiometryResult {
     reason: string;
 }
 /**
- * The signature of the callback passed to addResumeListener().
+ * The signature of the callback passed to `addResumeListener()`.
  */
 export declare type ResumeListener = (info: CheckBiometryResult) => void;
-export interface WSBiometricAuthPlugin {
+export interface BiometricAuthPlugin extends DecoratedNativePlugin {
     /**
      * Check to see what biometry type (if any) is available.
-     * For testing on the web, a BiometryType name (case-sensitive)
-     * may be specified as an environment variable. For example:
-     *
-     * WS_BIOMETRY_TYPE=touchId
      */
-    checkBiometry(): Promise<CheckBiometryResult>;
+    checkBiometry: () => Promise<CheckBiometryResult>;
     /**
      * web only
      *
      * On the web, this method allows you to dynamically simulate
-     * different types of biometry. You may either pass a BiometryType enum
-     * or the string name of a BiometryType. If a string is passed and
-     * it isn't a valid
+     * different types of biometry. You may either pass a `BiometryType` enum
+     * or the string name of a `BiometryType`. If a string is passed and
+     * it isn't a valid value, nothing happens.
      */
-    setBiometryType(type: BiometryType | string | undefined): void;
+    setBiometryType: (type: BiometryType | string | undefined) => void;
     /**
      * Prompt the user for authentication. If authorization fails for any reason,
-     * the promise is rejected with a BiometryError.
+     * the promise is rejected with a `BiometryError`.
      *
      * @param {AuthenticateOptions} options
      * @returns {Promise<void>}
      * @rejects {BiometryError}
      */
-    authenticate(options?: AuthenticateOptions): Promise<void>;
+    authenticate: (options?: AuthenticateOptions) => Promise<void>;
     /**
      * Register a function that will be called when the app resumes.
-     * The function will be passed the result of checkBiometry().
+     * The function will be passed the result of `checkBiometry()`.
      *
      * @param {ResumeListener} listener
      * @returns {boolean} true if the listener is successfully added
      */
-    addResumeListener(listener: ResumeListener): void;
+    addResumeListener: (listener: ResumeListener) => Promise<PluginListenerHandle>;
 }
+export declare const kPluginName = "BiometricAuth";

package/dist/esm/definitions.js

@@ -26,7 +26,7 @@ export var BiometryType;
     BiometryType[BiometryType["irisAuthentication"] = 5] = "irisAuthentication";
 })(BiometryType || (BiometryType = {}));
 /**
- * If the authenticate() method throws an exception, the error object
+ * If the `authenticate()` method throws an exception, the error object
  * contains a .code property which will contain one of these strings,
  * indicating what the error was.
  *
@@ -54,4 +54,5 @@ export class BiometryError {
         this.code = BiometryErrorType[code];
     }
 }
+export const kPluginName = 'BiometricAuth';
 //# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,YA8BX;AA9BD,WAAY,YAAY;IACtB;;OAEG;IACH,+CAAI,CAAA;IAEJ;;OAEG;IACH,qDAAO,CAAA;IAEP;;OAEG;IACH,mDAAM,CAAA;IAEN;;OAEG;IACH,yFAAyB,CAAA;IAEzB;;OAEG;IACH,2EAAkB,CAAA;IAElB;;OAEG;IACH,2EAAkB,CAAA;AACpB,CAAC,EA9BW,YAAY,KAAZ,YAAY,QA8BvB;AAyFD;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,iBAaX;AAbD,WAAY,iBAAiB;IAC3B,mEAAS,CAAA;IACT,yFAAoB,CAAA;IACpB,6EAAc,CAAA;IACd,6EAAc,CAAA;IACd,6EAAc,CAAA;IACd,yEAAY,CAAA;IACZ,qEAAU,CAAA;IACV,yEAAY,CAAA;IACZ,+EAAe,CAAA;IACf,yFAAoB,CAAA;IACpB,wFAAmB,CAAA;IACnB,sFAAkB,CAAA;AACpB,CAAC,EAbW,iBAAiB,KAAjB,iBAAiB,QAa5B;AAMD,MAAM,OAAO,aAAa;IAIxB,YAAY,OAAe,EAAE,IAAuB;QAClD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;CACF;AAuED,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAA","sourcesContent":["import type { DecoratedNativePlugin } from '@aparajita/capacitor-native-decorator'\nimport type { PluginListenerHandle, PluginResultError } from '@capacitor/core'\n\nexport enum BiometryType {\n  /**\n   * No biometry is available\n   */\n  none,\n\n  /**\n   * iOS Touch ID is available\n   */\n  touchId,\n\n  /**\n   * iOS Face ID is available\n   */\n  faceId,\n\n  /**\n   * Android fingerprint authentication is available\n   */\n  fingerprintAuthentication,\n\n  /**\n   * Android face authentication is available\n   */\n  faceAuthentication,\n\n  /**\n   * Android iris authentication is available\n   */\n  irisAuthentication\n}\n\nexport interface AuthenticateOptions {\n  /**\n   * The reason for requesting authentication. Displays in the authentication dialog presented to the user. If not supplied, a default message is displayed.\n   */\n  reason?: string\n\n  /**\n   * iOS:\n   * The system presents a cancel button during biometric authentication\n   * to let the user abort the authentication attempt. The button appears\n   * every time the system asks the user to present a finger registered with\n   * Touch ID. For Face ID, the button only appears if authentication fails\n   * and the user is prompted to try again. Either way, the user can stop\n   * trying to authenticate by tapping the button.\n   *\n   * Android:\n   * The text for the negative button. This would typically be used as a \"Cancel\" button,\n   * but may be also used to show an alternative method for authentication, such as a\n   * screen that asks for a backup password.\n   *\n   * Default: \"Cancel\"\n   */\n  cancelTitle?: string\n\n  /**\n   * If true, allows for authentication using device unlock credentials. Default is false.\n   *\n   * iOS:\n   * If biometry is available, enrolled, and not disabled, the system uses that first.\n   * After the first Touch ID failure or second Face ID failure, if `iosFallbackTitle`\n   * is not an empty string, a fallback button appears in the authentication dialog.\n   * If the user taps the fallback button, the system prompts the user for the device\n   * passcode or the user’s password. If `iosFallbackTitle` is an empty string, no\n   * fallback button will appear.\n   *\n   * If biometry is not available, enrolled and enabled, and a passcode is set,\n   * the system immediately prompts the user for the device passcode or user’s password.\n   * Authentication fails with the error code `passcodeNotSet` if the device passcode isn’t enabled.\n   *\n   * If a passcode is not set on the device, a `passcodeNotSet` error is returned.\n   *\n   * The system disables passcode authentication after 6 unsuccessful attempts, with progressively\n   * increasing delays between attempts.\n   *\n   * The title of the fallback button may be customized by setting `iosFallbackTitle` to\n   * a non-empty string.\n   *\n   * Android:\n   * The user will first be prompted to authenticate with biometrics, but also given\n   * the option to authenticate with their device PIN, pattern, or password by tapping\n   * a button in the authentication dialog. The title of the button is supplied by\n   * the system.\n   */\n  allowDeviceCredential?: boolean\n\n  /**\n   * The system presents a fallback button when biometric authentication fails\n   * — for example, because the system doesn’t recognize the presented finger,\n   * or after several failed attempts to recognize the user’s face.\n   *\n   * If `allowDeviceCredential` is false, tapping this button dismisses the\n   * authentication dialog and returns the error code userFallback. If undefined,\n   * the localized systetm default title is used. Passing an empty string\n   * hides the fallback button completely.\n   *\n   * If `allowDeviceCredential` is true and this is undefined,\n   * the localized system default title is used.\n   */\n  iosFallbackTitle?: string\n\n  /**\n   * Title for the Android dialog. If not supplied, the system default is used.\n   */\n  androidTitle?: string\n\n  /**\n   * Subtitle for the Android dialog. If not supplied, the system default is used.\n   */\n  androidSubtitle?: string\n\n  /**\n   * The maximum number of failed biometric verification attempts before\n   * returning `BiometryError.authenticationFailed`. The default is 3.\n   */\n  androidMaxAttempts?: number\n}\n\n/**\n * If the `authenticate()` method throws an exception, the error object\n * contains a .code property which will contain one of these strings,\n * indicating what the error was.\n *\n * See https://developer.apple.com/documentation/localauthentication/laerror\n * for a description of each error code.\n */\nexport enum BiometryErrorType {\n  appCancel,\n  authenticationFailed,\n  invalidContext,\n  notInteractive,\n  passcodeNotSet,\n  systemCancel,\n  userCancel,\n  userFallback,\n  biometryLockout,\n  biometryNotAvailable,\n  biometryNotEnrolled,\n  noDeviceCredential\n}\n\nexport interface ResultError extends PluginResultError {\n  code: string\n}\n\nexport class BiometryError implements ResultError {\n  message: string\n  code: string\n\n  constructor(message: string, code: BiometryErrorType) {\n    this.message = message\n    this.code = BiometryErrorType[code]\n  }\n}\n\nexport interface CheckBiometryResult {\n  /**\n   * True if the device has biometric authentication capability\n   * and the current user has enrolled in biometry.\n   */\n  isAvailable: boolean\n\n  /**\n   * The type of biometry available on the device.\n   */\n  biometryType: BiometryType\n\n  /**\n   * If biometry is not available and the system gives a reason why,\n   * it will be returned here. Otherwise it's an empty string.\n   */\n  reason: string\n}\n\n/**\n * The signature of the callback passed to `addResumeListener()`.\n */\nexport type ResumeListener = (info: CheckBiometryResult) => void\n\nexport interface BiometricAuthPlugin extends DecoratedNativePlugin {\n  /**\n   * Check to see what biometry type (if any) is available.\n   */\n  checkBiometry: () => Promise<CheckBiometryResult>\n\n  /**\n   * web only\n   *\n   * On the web, this method allows you to dynamically simulate\n   * different types of biometry. You may either pass a `BiometryType` enum\n   * or the string name of a `BiometryType`. If a string is passed and\n   * it isn't a valid value, nothing happens.\n   */\n  setBiometryType: (type: BiometryType | string | undefined) => void\n\n  /**\n   * Prompt the user for authentication. If authorization fails for any reason,\n   * the promise is rejected with a `BiometryError`.\n   *\n   * @param {AuthenticateOptions} options\n   * @returns {Promise<void>}\n   * @rejects {BiometryError}\n   */\n  authenticate: (options?: AuthenticateOptions) => Promise<void>\n\n  /**\n   * Register a function that will be called when the app resumes.\n   * The function will be passed the result of `checkBiometry()`.\n   *\n   * @param {ResumeListener} listener\n   * @returns {boolean} true if the listener is successfully added\n   */\n  addResumeListener: (listener: ResumeListener) => Promise<PluginListenerHandle>\n}\n\n/**\n * Return a human-readable name for a `BiometryType`.\n *\n * @param {BiometryType} type\n * @returns {string}\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\ndeclare function getBiometryName(type: BiometryType): string\n\nexport const kPluginName = 'BiometricAuth'\n"]}

package/dist/esm/index.d.ts

@@ -1,2 +1,5 @@
+import type { BiometricAuthPlugin } from './definitions';
+declare const biometricAuth: BiometricAuthPlugin;
 export * from './definitions';
-export * from './web';
+export { biometricAuth as BiometricAuth };
+export { getBiometryName } from './web';

package/dist/esm/index.js

@@ -1,3 +1,17 @@
+import { registerPlugin } from '@capacitor/core';
+import { kPluginName } from './definitions';
+import { BiometricAuth } from './web';
+// Because we are using @aparajita/capacitor-native-decorator,
+// we have one version of the TS code to rule them all, and there
+// is no need to lazy load. 😁
+const plugin = new BiometricAuth();
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const biometricAuth = registerPlugin(kPluginName, {
+    web: plugin,
+    ios: plugin,
+    android: plugin
+});
 export * from './definitions';
-export * from './web';
+export { biometricAuth as BiometricAuth };
+export { getBiometryName } from './web';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAErC,8DAA8D;AAC9D,iEAAiE;AACjE,8BAA8B;AAC9B,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAA;AAElC,gEAAgE;AAChE,MAAM,aAAa,GAAG,cAAc,CAAsB,WAAW,EAAE;IACrE,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;IACX,OAAO,EAAE,MAAM;CAChB,CAAC,CAAA;AAEF,cAAc,eAAe,CAAA;AAC7B,OAAO,EAAE,aAAa,IAAI,aAAa,EAAE,CAAA;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAA","sourcesContent":["import { registerPlugin } from '@capacitor/core'\nimport { kPluginName } from './definitions'\nimport type { BiometricAuthPlugin } from './definitions'\nimport { BiometricAuth } from './web'\n\n// Because we are using @aparajita/capacitor-native-decorator,\n// we have one version of the TS code to rule them all, and there\n// is no need to lazy load. 😁\nconst plugin = new BiometricAuth()\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst biometricAuth = registerPlugin<BiometricAuthPlugin>(kPluginName, {\n  web: plugin,\n  ios: plugin,\n  android: plugin\n})\n\nexport * from './definitions'\nexport { biometricAuth as BiometricAuth }\nexport { getBiometryName } from './web'\n"]}

package/dist/esm/web.d.ts

@@ -1,12 +1,14 @@
 import { WebPlugin } from '@capacitor/core';
-import { CheckBiometryResult, AuthenticateOptions, BiometryType, WSBiometricAuthPlugin, ResumeListener } from './definitions';
-export declare class WSBiometricAuthWeb extends WebPlugin implements WSBiometricAuthPlugin {
+import type { PluginListenerHandle } from '@capacitor/core';
+import type { AuthenticateOptions, BiometricAuthPlugin, CheckBiometryResult, ResumeListener } from './definitions';
+import { BiometryType } from './definitions';
+export declare class BiometricAuth extends WebPlugin implements BiometricAuthPlugin {
     private biometryType;
-    constructor();
+    getRegisteredPluginName(): string;
     setBiometryType(type: BiometryType | string | undefined): void;
     checkBiometry(): Promise<CheckBiometryResult>;
     authenticate(options?: AuthenticateOptions): Promise<void>;
-    addResumeListener(listener: ResumeListener): void;
+    addResumeListener(listener: ResumeListener): Promise<PluginListenerHandle> & PluginListenerHandle;
 }
 /**
  * Return a human-readable name for a BiometryType.
@@ -15,5 +17,3 @@ export declare class WSBiometricAuthWeb extends WebPlugin implements WSBiometric
  * @returns {string}
  */
 export declare function getBiometryName(type: BiometryType): string;
-declare const WSBiometricAuth: WSBiometricAuthWeb;
-export { WSBiometricAuth };

package/dist/esm/web.js

@@ -1,30 +1,37 @@
-import { __decorate } from "tslib";
-import { Plugins, registerWebPlugin, WebPlugin } from '@capacitor/core';
-import { BiometryError, BiometryErrorType, BiometryType, } from './definitions';
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 import { native } from '@aparajita/capacitor-native-decorator';
+import { App } from '@capacitor/app';
+import { WebPlugin } from '@capacitor/core';
+import { BiometryError, BiometryErrorType, BiometryType, kPluginName } from './definitions';
 const kBiometryTypeNameMap = {
     [BiometryType.none]: '',
     [BiometryType.touchId]: 'Touch ID',
     [BiometryType.faceId]: 'Face ID',
     [BiometryType.fingerprintAuthentication]: 'Fingerprint Authentication',
     [BiometryType.faceAuthentication]: 'Face Authentication',
-    [BiometryType.irisAuthentication]: 'Iris Authentication',
+    [BiometryType.irisAuthentication]: 'Iris Authentication'
 };
-export class WSBiometricAuthWeb extends WebPlugin {
+export class BiometricAuth extends WebPlugin {
     constructor() {
-        super({
-            name: 'WSBiometricAuth',
-            platforms: ['web', 'ios', 'android'],
-        });
+        super(...arguments);
         this.biometryType = BiometryType.none;
-        this.setBiometryType(process.env.WS_BIOMETRY_TYPE);
+    }
+    getRegisteredPluginName() {
+        return kPluginName;
     }
     setBiometryType(type) {
         if (typeof type === 'undefined') {
             return;
         }
         if (typeof type === 'string') {
-            if (type && BiometryType.hasOwnProperty(type)) {
+            // eslint-disable-next-line no-prototype-builtins
+            if (BiometryType.hasOwnProperty(type)) {
+                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
                 this.biometryType = BiometryType[type];
             }
         }
@@ -32,17 +39,19 @@ export class WSBiometricAuthWeb extends WebPlugin {
             this.biometryType = type;
         }
     }
-    checkBiometry() {
+    async checkBiometry() {
         return Promise.resolve({
             isAvailable: this.biometryType !== BiometryType.none,
             biometryType: this.biometryType,
-            reason: '',
+            reason: ''
         });
     }
-    authenticate(options) {
+    async authenticate(options) {
         return this.checkBiometry().then(({ isAvailable, biometryType }) => {
             if (isAvailable) {
-                if (confirm((options === null || options === void 0 ? void 0 : options.reason) ||
+                if (
+                // eslint-disable-next-line no-alert
+                confirm((options === null || options === void 0 ? void 0 : options.reason) ||
                     `Authenticate with ${kBiometryTypeNameMap[biometryType]}?`)) {
                     return;
                 }
@@ -52,23 +61,25 @@ export class WSBiometricAuthWeb extends WebPlugin {
         });
     }
     addResumeListener(listener) {
-        const app = Plugins.App;
-        if (app) {
-            app.addListener('appStateChange', async (state) => {
-                if (state.isActive) {
-                    const info = await this.checkBiometry();
+        return App.addListener('appStateChange', ({ isActive }) => {
+            if (isActive) {
+                this.checkBiometry()
+                    .then((info) => {
                     listener(info);
-                }
-            });
-        }
+                })
+                    .catch((error) => {
+                    console.error(error.message);
+                });
+            }
+        });
     }
 }
 __decorate([
     native()
-], WSBiometricAuthWeb.prototype, "checkBiometry", null);
+], BiometricAuth.prototype, "checkBiometry", null);
 __decorate([
     native()
-], WSBiometricAuthWeb.prototype, "authenticate", null);
+], BiometricAuth.prototype, "authenticate", null);
 /**
  * Return a human-readable name for a BiometryType.
  *
@@ -78,7 +89,4 @@ __decorate([
 export function getBiometryName(type) {
     return kBiometryTypeNameMap[type] || '';
 }
-const WSBiometricAuth = new WSBiometricAuthWeb();
-export { WSBiometricAuth };
-registerWebPlugin(WSBiometricAuth);
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAA;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAQ3C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACZ,MAAM,eAAe,CAAA;AAEtB,MAAM,oBAAoB,GAAG;IAC3B,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE;IACvB,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,UAAU;IAClC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS;IAChC,CAAC,YAAY,CAAC,yBAAyB,CAAC,EAAE,4BAA4B;IACtE,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,qBAAqB;IACxD,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,qBAAqB;CACzD,CAAA;AAED,MAAM,OAAO,aAAc,SAAQ,SAAS;IAA5C;;QACU,iBAAY,GAAiB,YAAY,CAAC,IAAI,CAAA;IAsExD,CAAC;IApEC,uBAAuB;QACrB,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,eAAe,CAAC,IAAuC;QACrD,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;YAC/B,OAAM;SACP;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,iDAAiD;YACjD,IAAI,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;gBACrC,yEAAyE;gBACzE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,IAAiC,CAAC,CAAA;aACpE;SACF;aAAM;YACL,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;SACzB;IACH,CAAC;IAGD,KAAK,CAAC,aAAa;QACjB,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,WAAW,EAAE,IAAI,CAAC,YAAY,KAAK,YAAY,CAAC,IAAI;YACpD,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,MAAM,EAAE,EAAE;SACX,CAAC,CAAA;IACJ,CAAC;IAGD,KAAK,CAAC,YAAY,CAAC,OAA6B;QAC9C,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,EAAE,EAAE;YACjE,IAAI,WAAW,EAAE;gBACf;gBACE,oCAAoC;gBACpC,OAAO,CACL,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;oBACb,qBAAqB,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAC7D,EACD;oBACA,OAAM;iBACP;gBAED,MAAM,IAAI,aAAa,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAA;aACxE;YAED,MAAM,IAAI,aAAa,CACrB,wBAAwB,EACxB,iBAAiB,CAAC,oBAAoB,CACvC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,iBAAiB,CACf,QAAwB;QAExB,OAAO,GAAG,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAQ,EAAE;YAC9D,IAAI,QAAQ,EAAE;gBACZ,IAAI,CAAC,aAAa,EAAE;qBACjB,IAAI,CAAC,CAAC,IAAyB,EAAE,EAAE;oBAClC,QAAQ,CAAC,IAAI,CAAC,CAAA;gBAChB,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;oBACtB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC9B,CAAC,CAAC,CAAA;aACL;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA/CC;IADC,MAAM,EAAE;kDAOR;AAGD;IADC,MAAM,EAAE;iDAsBR;AAmBH;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAkB;IAChD,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;AACzC,CAAC","sourcesContent":["import { native } from '@aparajita/capacitor-native-decorator'\nimport { App } from '@capacitor/app'\nimport { WebPlugin } from '@capacitor/core'\nimport type { PluginListenerHandle } from '@capacitor/core'\nimport type {\n  AuthenticateOptions,\n  BiometricAuthPlugin,\n  CheckBiometryResult,\n  ResumeListener\n} from './definitions'\nimport {\n  BiometryError,\n  BiometryErrorType,\n  BiometryType,\n  kPluginName\n} from './definitions'\n\nconst kBiometryTypeNameMap = {\n  [BiometryType.none]: '',\n  [BiometryType.touchId]: 'Touch ID',\n  [BiometryType.faceId]: 'Face ID',\n  [BiometryType.fingerprintAuthentication]: 'Fingerprint Authentication',\n  [BiometryType.faceAuthentication]: 'Face Authentication',\n  [BiometryType.irisAuthentication]: 'Iris Authentication'\n}\n\nexport class BiometricAuth extends WebPlugin implements BiometricAuthPlugin {\n  private biometryType: BiometryType = BiometryType.none\n\n  getRegisteredPluginName(): string {\n    return kPluginName\n  }\n\n  setBiometryType(type: BiometryType | string | undefined): void {\n    if (typeof type === 'undefined') {\n      return\n    }\n\n    if (typeof type === 'string') {\n      // eslint-disable-next-line no-prototype-builtins\n      if (BiometryType.hasOwnProperty(type)) {\n        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n        this.biometryType = BiometryType[type as keyof typeof BiometryType]\n      }\n    } else {\n      this.biometryType = type\n    }\n  }\n\n  @native()\n  async checkBiometry(): Promise<CheckBiometryResult> {\n    return Promise.resolve({\n      isAvailable: this.biometryType !== BiometryType.none,\n      biometryType: this.biometryType,\n      reason: ''\n    })\n  }\n\n  @native()\n  async authenticate(options?: AuthenticateOptions): Promise<void> {\n    return this.checkBiometry().then(({ isAvailable, biometryType }) => {\n      if (isAvailable) {\n        if (\n          // eslint-disable-next-line no-alert\n          confirm(\n            options?.reason ||\n              `Authenticate with ${kBiometryTypeNameMap[biometryType]}?`\n          )\n        ) {\n          return\n        }\n\n        throw new BiometryError('User cancelled', BiometryErrorType.userCancel)\n      }\n\n      throw new BiometryError(\n        'Biometry not available',\n        BiometryErrorType.biometryNotAvailable\n      )\n    })\n  }\n\n  addResumeListener(\n    listener: ResumeListener\n  ): Promise<PluginListenerHandle> & PluginListenerHandle {\n    return App.addListener('appStateChange', ({ isActive }): void => {\n      if (isActive) {\n        this.checkBiometry()\n          .then((info: CheckBiometryResult) => {\n            listener(info)\n          })\n          .catch((error: Error) => {\n            console.error(error.message)\n          })\n      }\n    })\n  }\n}\n\n/**\n * Return a human-readable name for a BiometryType.\n *\n * @param {BiometryType} type\n * @returns {string}\n */\nexport function getBiometryName(type: BiometryType): string {\n  return kBiometryTypeNameMap[type] || ''\n}\n"]}