@aparajita/capacitor-biometric-auth 8.0.2 → 9.1.0

package/dist/plugin.cjs.js

@@ -66,13 +66,22 @@ exports.BiometryErrorType = void 0;
     BiometryErrorType["biometryNotEnrolled"] = "biometryNotEnrolled";
     BiometryErrorType["noDeviceCredential"] = "noDeviceCredential";
 })(exports.BiometryErrorType || (exports.BiometryErrorType = {}));
+function isBiometryErrorType(value) {
+    return (typeof value === 'string' &&
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+        Object.values(exports.BiometryErrorType).includes(value));
+}
 /**
  * `authenticate()` throws instances of this class.
  */
-class BiometryError {
+class BiometryError extends Error {
     constructor(message, code) {
-        this.message = message;
+        super(message);
         this.code = code;
+        this.name = 'BiometryError';
+        // Set the prototype explicitly to ensure instanceof works correctly.
+        // This is recommended for custom error classes in TypeScript.
+        Object.setPrototypeOf(this, BiometryError.prototype);
     }
 }
 
@@ -87,15 +96,23 @@ const kBiometryTypeNameMap = {
 /**
  * Return a human-readable name for a BiometryType.
  */
-// eslint-disable-next-line import/prefer-default-export
 function getBiometryName(type) {
     return kBiometryTypeNameMap[type] || '';
 }
 
 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)),
+    web: async () => {
+        const module = await Promise.resolve().then(function () { return web; });
+        return new module.BiometricAuthWeb();
+    },
+    ios: async () => {
+        const module = await Promise.resolve().then(function () { return native; });
+        return new module.BiometricAuthNative(proxy);
+    },
+    android: async () => {
+        const module = await Promise.resolve().then(function () { return native; });
+        return new module.BiometricAuthNative(proxy);
+    },
 });
 
 class BiometricAuthBase extends core.WebPlugin {
@@ -106,28 +123,30 @@ class BiometricAuthBase extends core.WebPlugin {
         catch (error) {
             // 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, error.code);
-            }
-            else {
-                throw error;
-            }
+            throw error instanceof core.CapacitorException &&
+                isBiometryErrorType(error.code)
+                ? new BiometryError(error.message, error.code)
+                : error;
         }
     }
     async addResumeListener(listener) {
         return app.App.addListener('appStateChange', ({ isActive }) => {
             if (isActive) {
-                this.checkBiometry()
-                    .then((info) => {
-                    listener(info);
-                })
-                    .catch(console.error);
+                (async () => {
+                    try {
+                        const info = await this.checkBiometry();
+                        listener(info);
+                    }
+                    catch (error) {
+                        console.error(error);
+                    }
+                })();
             }
         });
     }
 }
 
-// eslint-disable-next-line import/prefer-default-export
+/* eslint-disable @typescript-eslint/require-await */
 class BiometricAuthWeb extends BiometricAuthBase {
     constructor() {
         super(...arguments);
@@ -150,7 +169,7 @@ class BiometricAuthWeb extends BiometricAuthBase {
             reason = 'Biometry is not enrolled';
             code = exports.BiometryErrorType.biometryNotEnrolled;
         }
-        return Promise.resolve({
+        return {
             isAvailable: available,
             strongBiometryIsAvailable: this.biometryIsEnrolled && this.hasStrongBiometry(),
             biometryType: this.biometryType,
@@ -158,38 +177,36 @@ class BiometricAuthWeb extends BiometricAuthBase {
             deviceIsSecure: this.deviceIsSecure,
             reason,
             code,
-        });
+        };
     }
     hasStrongBiometry() {
         return this.biometryTypes.some((type) => type === exports.BiometryType.faceId ||
             type === exports.BiometryType.touchId ||
             type === exports.BiometryType.fingerprintAuthentication);
     }
-    /* eslint-disable no-alert */
     // On the web, fake authentication with a confirm dialog.
     async internalAuthenticate(options) {
         const result = await this.checkBiometry();
         // First try biometry if available.
-        if (result.isAvailable) {
-            if (confirm(
+        if (result.isAvailable &&
+            // oxlint-disable-next-line no-alert
+            confirm(
             // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- we want to use the default value if options?.reason is an empty string
             (options === null || options === void 0 ? void 0 : options.reason) ||
                 `Authenticate with ${result.biometryTypes
                     .map((type) => getBiometryName(type))
                     .join(' or ')}?`)) {
-                return;
-            }
+            return;
         }
         if (options === null || options === void 0 ? void 0 : options.allowDeviceCredential) {
             // Either biometry is not available, or the user declined to use it
             // and device security is allowed.
             if (result.deviceIsSecure) {
+                // oxlint-disable-next-line no-alert
                 if (confirm('Authenticate with device security?')) {
                     return;
                 }
-                else {
-                    throw new BiometryError('User cancelled', exports.BiometryErrorType.userCancel);
-                }
+                throw new BiometryError('User cancelled', exports.BiometryErrorType.userCancel);
             }
             else if (result.isAvailable) {
                 throw new BiometryError('Device is not secure', exports.BiometryErrorType.noDeviceCredential);
@@ -197,12 +214,9 @@ class BiometricAuthWeb extends BiometricAuthBase {
         }
         else if (!result.isAvailable) {
             // Biometry is not available and device security is not allowed.
-            if (result.biometryType === exports.BiometryType.none) {
-                throw new BiometryError('Biometry is not available', exports.BiometryErrorType.biometryNotAvailable);
-            }
-            else {
-                throw new BiometryError('Biometry is not enrolled', exports.BiometryErrorType.biometryNotEnrolled);
-            }
+            throw result.biometryType === exports.BiometryType.none
+                ? new BiometryError('Biometry is not available', exports.BiometryErrorType.biometryNotAvailable)
+                : new BiometryError('Biometry is not enrolled', exports.BiometryErrorType.biometryNotEnrolled);
         }
         // The user declined to use biometry and device credentials not allowed.
         throw new BiometryError('User cancelled', exports.BiometryErrorType.userCancel);
@@ -210,13 +224,13 @@ class BiometricAuthWeb extends BiometricAuthBase {
     // Web only, used for simulating biometric authentication.
     async setBiometryType(type) {
         if (type === undefined) {
-            return Promise.resolve();
+            return;
         }
         const types = Array.isArray(type) ? type : [type];
         this.biometryTypes = [];
         this.biometryType = exports.BiometryType.none;
         if (types.length === 0) {
-            return Promise.resolve();
+            return;
         }
         if (isBiometryTypes(types)) {
             this.biometryType = types[0];
@@ -225,46 +239,45 @@ class BiometricAuthWeb extends BiometricAuthBase {
             }
         }
         else {
-            for (let i = 0; i < types.length; i++) {
-                // eslint-disable-next-line no-prototype-builtins
-                if (exports.BiometryType.hasOwnProperty(types[i])) {
-                    const biometryType = exports.BiometryType[types[i]];
+            for (const [i, theType] of types.entries()) {
+                if (isBiometryType(theType)) {
                     if (this.biometryType === exports.BiometryType.none) {
                         this.biometryTypes = [];
                     }
                     else {
-                        this.biometryTypes.push(biometryType);
+                        this.biometryTypes.push(theType);
                     }
                     if (i === 0) {
-                        this.biometryType = biometryType;
+                        this.biometryType = theType;
                     }
                 }
             }
         }
-        return Promise.resolve();
     }
     // Web only, used for simulating device unlock security.
     async setBiometryIsEnrolled(enrolled) {
         this.biometryIsEnrolled = enrolled;
-        return Promise.resolve();
     }
     // Web only, used for simulating device unlock security.
     async setDeviceIsSecure(isSecure) {
         this.deviceIsSecure = isSecure;
-        return Promise.resolve();
     }
 }
+function isBiometryType(value) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+    return Object.values(exports.BiometryType).includes(value);
+}
 function isBiometryTypes(value) {
-    return Object.values(exports.BiometryType).includes(value[0]);
+    return value.every((type) => isBiometryType(type));
 }
+/* eslint-enable @typescript-eslint/require-await */
 
 var web = /*#__PURE__*/Object.freeze({
     __proto__: null,
     BiometricAuthWeb: BiometricAuthWeb
 });
 
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/require-await */
-// eslint-disable-next-line import/prefer-default-export
+/* eslint-disable @typescript-eslint/class-methods-use-this, @typescript-eslint/require-await */
 class BiometricAuthNative extends BiometricAuthBase {
     constructor(capProxy) {
         super();
@@ -276,6 +289,7 @@ 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/no-unsafe-type-assertion
         const proxy = capProxy;
         /* eslint-disable @typescript-eslint/unbound-method */
         this.checkBiometry = proxy.checkBiometry;
@@ -285,7 +299,7 @@ class BiometricAuthNative extends BiometricAuthBase {
     // @native
     async checkBiometry() {
         // Never used, but we have to satisfy the compiler.
-        return Promise.resolve({
+        return {
             isAvailable: false,
             strongBiometryIsAvailable: false,
             biometryType: exports.BiometryType.none,
@@ -295,24 +309,27 @@ class BiometricAuthNative extends BiometricAuthBase {
             code: exports.BiometryErrorType.none,
             strongReason: '',
             strongCode: exports.BiometryErrorType.none,
-        });
+        };
     }
     // @native
     // On native platforms, this will present the native authentication UI.
-    async internalAuthenticate(options) { }
+    async internalAuthenticate(_options) {
+        // This method is implemented natively
+    }
     // Web only, used for simulating biometric authentication.
-    async setBiometryType(type) {
+    async setBiometryType(_type) {
         console.warn('setBiometryType() is web only');
     }
     // Web only, used for simulating biometry enrollment.
-    async setBiometryIsEnrolled(enrolled) {
+    async setBiometryIsEnrolled(_enrolled) {
         console.warn('setBiometryEnrolled() is web only');
     }
     // Web only, used for simulating device security.
-    async setDeviceIsSecure(isSecure) {
+    async setDeviceIsSecure(_isSecure) {
         console.warn('setDeviceIsSecure() is web only');
     }
 }
+/* eslint-enable @typescript-eslint/class-methods-use-this, @typescript-eslint/require-await */
 
 var native = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -322,3 +339,4 @@ var native = /*#__PURE__*/Object.freeze({
 exports.BiometricAuth = proxy;
 exports.BiometryError = BiometryError;
 exports.getBiometryName = getBiometryName;
+exports.isBiometryErrorType = isBiometryErrorType;

package/dist/plugin.js

@@ -64,13 +64,22 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         BiometryErrorType["biometryNotEnrolled"] = "biometryNotEnrolled";
         BiometryErrorType["noDeviceCredential"] = "noDeviceCredential";
     })(exports.BiometryErrorType || (exports.BiometryErrorType = {}));
+    function isBiometryErrorType(value) {
+        return (typeof value === 'string' &&
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+            Object.values(exports.BiometryErrorType).includes(value));
+    }
     /**
      * `authenticate()` throws instances of this class.
      */
-    class BiometryError {
+    class BiometryError extends Error {
         constructor(message, code) {
-            this.message = message;
+            super(message);
             this.code = code;
+            this.name = 'BiometryError';
+            // Set the prototype explicitly to ensure instanceof works correctly.
+            // This is recommended for custom error classes in TypeScript.
+            Object.setPrototypeOf(this, BiometryError.prototype);
         }
     }
 
@@ -85,15 +94,23 @@ var capacitorBiometricAuth = (function (exports, core, app) {
     /**
      * Return a human-readable name for a BiometryType.
      */
-    // eslint-disable-next-line import/prefer-default-export
     function getBiometryName(type) {
         return kBiometryTypeNameMap[type] || '';
     }
 
     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)),
+        web: async () => {
+            const module = await Promise.resolve().then(function () { return web; });
+            return new module.BiometricAuthWeb();
+        },
+        ios: async () => {
+            const module = await Promise.resolve().then(function () { return native; });
+            return new module.BiometricAuthNative(proxy);
+        },
+        android: async () => {
+            const module = await Promise.resolve().then(function () { return native; });
+            return new module.BiometricAuthNative(proxy);
+        },
     });
 
     class BiometricAuthBase extends core.WebPlugin {
@@ -104,28 +121,30 @@ var capacitorBiometricAuth = (function (exports, core, app) {
             catch (error) {
                 // 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, error.code);
-                }
-                else {
-                    throw error;
-                }
+                throw error instanceof core.CapacitorException &&
+                    isBiometryErrorType(error.code)
+                    ? new BiometryError(error.message, error.code)
+                    : error;
             }
         }
         async addResumeListener(listener) {
             return app.App.addListener('appStateChange', ({ isActive }) => {
                 if (isActive) {
-                    this.checkBiometry()
-                        .then((info) => {
-                        listener(info);
-                    })
-                        .catch(console.error);
+                    (async () => {
+                        try {
+                            const info = await this.checkBiometry();
+                            listener(info);
+                        }
+                        catch (error) {
+                            console.error(error);
+                        }
+                    })();
                 }
             });
         }
     }
 
-    // eslint-disable-next-line import/prefer-default-export
+    /* eslint-disable @typescript-eslint/require-await */
     class BiometricAuthWeb extends BiometricAuthBase {
         constructor() {
             super(...arguments);
@@ -148,7 +167,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 reason = 'Biometry is not enrolled';
                 code = exports.BiometryErrorType.biometryNotEnrolled;
             }
-            return Promise.resolve({
+            return {
                 isAvailable: available,
                 strongBiometryIsAvailable: this.biometryIsEnrolled && this.hasStrongBiometry(),
                 biometryType: this.biometryType,
@@ -156,38 +175,36 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 deviceIsSecure: this.deviceIsSecure,
                 reason,
                 code,
-            });
+            };
         }
         hasStrongBiometry() {
             return this.biometryTypes.some((type) => type === exports.BiometryType.faceId ||
                 type === exports.BiometryType.touchId ||
                 type === exports.BiometryType.fingerprintAuthentication);
         }
-        /* eslint-disable no-alert */
         // On the web, fake authentication with a confirm dialog.
         async internalAuthenticate(options) {
             const result = await this.checkBiometry();
             // First try biometry if available.
-            if (result.isAvailable) {
-                if (confirm(
+            if (result.isAvailable &&
+                // oxlint-disable-next-line no-alert
+                confirm(
                 // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- we want to use the default value if options?.reason is an empty string
                 (options === null || options === void 0 ? void 0 : options.reason) ||
                     `Authenticate with ${result.biometryTypes
                     .map((type) => getBiometryName(type))
                     .join(' or ')}?`)) {
-                    return;
-                }
+                return;
             }
             if (options === null || options === void 0 ? void 0 : options.allowDeviceCredential) {
                 // Either biometry is not available, or the user declined to use it
                 // and device security is allowed.
                 if (result.deviceIsSecure) {
+                    // oxlint-disable-next-line no-alert
                     if (confirm('Authenticate with device security?')) {
                         return;
                     }
-                    else {
-                        throw new BiometryError('User cancelled', exports.BiometryErrorType.userCancel);
-                    }
+                    throw new BiometryError('User cancelled', exports.BiometryErrorType.userCancel);
                 }
                 else if (result.isAvailable) {
                     throw new BiometryError('Device is not secure', exports.BiometryErrorType.noDeviceCredential);
@@ -195,12 +212,9 @@ var capacitorBiometricAuth = (function (exports, core, app) {
             }
             else if (!result.isAvailable) {
                 // Biometry is not available and device security is not allowed.
-                if (result.biometryType === exports.BiometryType.none) {
-                    throw new BiometryError('Biometry is not available', exports.BiometryErrorType.biometryNotAvailable);
-                }
-                else {
-                    throw new BiometryError('Biometry is not enrolled', exports.BiometryErrorType.biometryNotEnrolled);
-                }
+                throw result.biometryType === exports.BiometryType.none
+                    ? new BiometryError('Biometry is not available', exports.BiometryErrorType.biometryNotAvailable)
+                    : new BiometryError('Biometry is not enrolled', exports.BiometryErrorType.biometryNotEnrolled);
             }
             // The user declined to use biometry and device credentials not allowed.
             throw new BiometryError('User cancelled', exports.BiometryErrorType.userCancel);
@@ -208,13 +222,13 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         // Web only, used for simulating biometric authentication.
         async setBiometryType(type) {
             if (type === undefined) {
-                return Promise.resolve();
+                return;
             }
             const types = Array.isArray(type) ? type : [type];
             this.biometryTypes = [];
             this.biometryType = exports.BiometryType.none;
             if (types.length === 0) {
-                return Promise.resolve();
+                return;
             }
             if (isBiometryTypes(types)) {
                 this.biometryType = types[0];
@@ -223,46 +237,45 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 }
             }
             else {
-                for (let i = 0; i < types.length; i++) {
-                    // eslint-disable-next-line no-prototype-builtins
-                    if (exports.BiometryType.hasOwnProperty(types[i])) {
-                        const biometryType = exports.BiometryType[types[i]];
+                for (const [i, theType] of types.entries()) {
+                    if (isBiometryType(theType)) {
                         if (this.biometryType === exports.BiometryType.none) {
                             this.biometryTypes = [];
                         }
                         else {
-                            this.biometryTypes.push(biometryType);
+                            this.biometryTypes.push(theType);
                         }
                         if (i === 0) {
-                            this.biometryType = biometryType;
+                            this.biometryType = theType;
                         }
                     }
                 }
             }
-            return Promise.resolve();
         }
         // Web only, used for simulating device unlock security.
         async setBiometryIsEnrolled(enrolled) {
             this.biometryIsEnrolled = enrolled;
-            return Promise.resolve();
         }
         // Web only, used for simulating device unlock security.
         async setDeviceIsSecure(isSecure) {
             this.deviceIsSecure = isSecure;
-            return Promise.resolve();
         }
     }
+    function isBiometryType(value) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+        return Object.values(exports.BiometryType).includes(value);
+    }
     function isBiometryTypes(value) {
-        return Object.values(exports.BiometryType).includes(value[0]);
+        return value.every((type) => isBiometryType(type));
     }
+    /* eslint-enable @typescript-eslint/require-await */
 
     var web = /*#__PURE__*/Object.freeze({
         __proto__: null,
         BiometricAuthWeb: BiometricAuthWeb
     });
 
-    /* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/require-await */
-    // eslint-disable-next-line import/prefer-default-export
+    /* eslint-disable @typescript-eslint/class-methods-use-this, @typescript-eslint/require-await */
     class BiometricAuthNative extends BiometricAuthBase {
         constructor(capProxy) {
             super();
@@ -274,6 +287,7 @@ 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/no-unsafe-type-assertion
             const proxy = capProxy;
             /* eslint-disable @typescript-eslint/unbound-method */
             this.checkBiometry = proxy.checkBiometry;
@@ -283,7 +297,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
         // @native
         async checkBiometry() {
             // Never used, but we have to satisfy the compiler.
-            return Promise.resolve({
+            return {
                 isAvailable: false,
                 strongBiometryIsAvailable: false,
                 biometryType: exports.BiometryType.none,
@@ -293,24 +307,27 @@ var capacitorBiometricAuth = (function (exports, core, app) {
                 code: exports.BiometryErrorType.none,
                 strongReason: '',
                 strongCode: exports.BiometryErrorType.none,
-            });
+            };
         }
         // @native
         // On native platforms, this will present the native authentication UI.
-        async internalAuthenticate(options) { }
+        async internalAuthenticate(_options) {
+            // This method is implemented natively
+        }
         // Web only, used for simulating biometric authentication.
-        async setBiometryType(type) {
+        async setBiometryType(_type) {
             console.warn('setBiometryType() is web only');
         }
         // Web only, used for simulating biometry enrollment.
-        async setBiometryIsEnrolled(enrolled) {
+        async setBiometryIsEnrolled(_enrolled) {
             console.warn('setBiometryEnrolled() is web only');
         }
         // Web only, used for simulating device security.
-        async setDeviceIsSecure(isSecure) {
+        async setDeviceIsSecure(_isSecure) {
             console.warn('setDeviceIsSecure() is web only');
         }
     }
+    /* eslint-enable @typescript-eslint/class-methods-use-this, @typescript-eslint/require-await */
 
     var native = /*#__PURE__*/Object.freeze({
         __proto__: null,
@@ -320,6 +337,7 @@ var capacitorBiometricAuth = (function (exports, core, app) {
     exports.BiometricAuth = proxy;
     exports.BiometryError = BiometryError;
     exports.getBiometryName = getBiometryName;
+    exports.isBiometryErrorType = isBiometryErrorType;
 
     return exports;
 

package/ios/Plugin/Plugin.swift

@@ -6,7 +6,14 @@ private let kReason = "reason"
 private let kMissingFaceIDUsageEntry = "The device supports Face ID, but NSFaceIDUsageDescription is not in Info.plist."
 
 @objc(BiometricAuthNative)
-public class BiometricAuthNative: CAPPlugin {
+public class BiometricAuthNative: CAPPlugin, CAPBridgedPlugin {
+  public let identifier = "BiometricAuthNative"
+  public let jsName = "BiometricAuthNative"
+  public let pluginMethods: [CAPPluginMethod] = [
+    .init(#selector(checkBiometry)),
+    .init(#selector(internalAuthenticate))
+  ]
+
   let biometryErrorCodeMap: [Int: String] = [
     0: "",
     LAError.appCancel.rawValue: "appCancel",