import { NativeModules } from "react-native"; const { ReactNativeBiometrics: bridge } = NativeModules; /** * Type alias for possible biometry types */ export type BiometryType = "TouchID" | "FaceID" | "Biometrics"; interface RNBiometricsOptions { allowDeviceCredentials?: boolean; } interface IsSensorAvailableResult { available: boolean; biometryType?: BiometryType; error?: string; } interface CreateKeysResult { publicKey: string; } interface BiometricKeysExistResult { keysExist: boolean; } interface DeleteKeysResult { keysDeleted: boolean; } interface CreateSignatureOptions { promptMessage: string; payload: string; cancelButtonText?: string; } interface CreateSignatureResult { success: boolean; signature?: string; error?: string; code?: string; } interface SimplePromptOptions { promptMessage: string; fallbackPromptMessage?: string; cancelButtonText?: string; } interface SimplePromptResult { success: boolean; error?: string; code?: string; } /** * Enum for touch id sensor type */ export const TouchID = "TouchID"; /** * Enum for face id sensor type */ export const FaceID = "FaceID"; /** * Enum for generic biometrics (this is the only value available on android) */ export const Biometrics = "Biometrics"; export const BiometryTypes = { TouchID, FaceID, Biometrics, }; export const ReactNativeBiometricsLegacy = { /** * Returns promise that resolves to an object with object.biometryType = Biometrics | TouchID | FaceID * @returns {Promise} Promise that resolves to an object with details about biometrics available */ isSensorAvailable(): Promise { return new ReactNativeBiometrics().isSensorAvailable(); }, /** * Creates a public private key pair,returns promise that resolves to * an object with object.publicKey, which is the public key of the newly generated key pair * @returns {Promise} Promise that resolves to object with details about the newly generated public key */ createKeys(): Promise { return new ReactNativeBiometrics().createKeys(); }, /** * Returns promise that resolves to an object with object.keysExists = true | false * indicating if the keys were found to exist or not * @returns {Promise} Promise that resolves to object with details about the existence of keys */ biometricKeysExist(): Promise { return new ReactNativeBiometrics().biometricKeysExist(); }, /** * Returns promise that resolves to an object with true | false * indicating if the keys were properly deleted * @returns {Promise} Promise that resolves to an object with details about the deletion */ deleteKeys(): Promise { return new ReactNativeBiometrics().deleteKeys(); }, /** * Prompts user with biometrics dialog using the passed in prompt message and * returns promise that resolves to an object with object.signature, * which is cryptographic signature of the payload * @param {Object} createSignatureOptions * @param {string} createSignatureOptions.promptMessage * @param {string} createSignatureOptions.payload * @returns {Promise} Promise that resolves to an object cryptographic signature details */ createSignature( createSignatureOptions: CreateSignatureOptions, ): Promise { return new ReactNativeBiometrics().createSignature(createSignatureOptions); }, /** * Prompts user with biometrics dialog using the passed in prompt message and * returns promise that resolves to an object with object.success = true if the user passes, * object.success = false if the user cancels, and rejects if anything fails * @param {Object} simplePromptOptions * @param {string} simplePromptOptions.promptMessage * @param {string} simplePromptOptions.fallbackPromptMessage * @returns {Promise} Promise that resolves an object with details about the biometrics result */ simplePrompt( simplePromptOptions: SimplePromptOptions, ): Promise { return new ReactNativeBiometrics().simplePrompt(simplePromptOptions); }, }; export default class ReactNativeBiometrics { allowDeviceCredentials = false; /** * @param {Object} rnBiometricsOptions * @param {boolean} rnBiometricsOptions.allowDeviceCredentials */ constructor(rnBiometricsOptions?: RNBiometricsOptions) { const allowDeviceCredentials = rnBiometricsOptions?.allowDeviceCredentials ?? false; this.allowDeviceCredentials = allowDeviceCredentials; } /** * Returns promise that resolves to an object with object.biometryType = Biometrics | TouchID | FaceID * @returns {Promise} Promise that resolves to an object with details about biometrics available */ isSensorAvailable(): Promise { return bridge.isSensorAvailable({ allowDeviceCredentials: this.allowDeviceCredentials, }); } /** * Creates a public private key pair,returns promise that resolves to * an object with object.publicKey, which is the public key of the newly generated key pair * @returns {Promise} Promise that resolves to object with details about the newly generated public key */ createKeys(): Promise { return bridge.createKeys({ allowDeviceCredentials: this.allowDeviceCredentials, }); } /** * Returns promise that resolves to an object with object.keysExists = true | false * indicating if the keys were found to exist or not * @returns {Promise} Promise that resolves to object with details aobut the existence of keys */ biometricKeysExist(): Promise { return bridge.biometricKeysExist(); } /** * Returns promise that resolves to an object with true | false * indicating if the keys were properly deleted * @returns {Promise} Promise that resolves to an object with details about the deletion */ deleteKeys(): Promise { return bridge.deleteKeys(); } /** * Prompts user with biometrics dialog using the passed in prompt message and * returns promise that resolves to an object with object.signature, * which is cryptographic signature of the payload * @param {Object} createSignatureOptions * @param {string} createSignatureOptions.promptMessage * @param {string} createSignatureOptions.payload * @returns {Promise} Promise that resolves to an object cryptographic signature details */ createSignature( createSignatureOptions: CreateSignatureOptions, ): Promise { createSignatureOptions.cancelButtonText = createSignatureOptions.cancelButtonText ?? "Cancel"; return bridge.createSignature({ allowDeviceCredentials: this.allowDeviceCredentials, ...createSignatureOptions, }); } /** * Prompts user with biometrics dialog using the passed in prompt message and * returns promise that resolves to an object with object.success = true if the user passes, * object.success = false if the user cancels, and rejects if anything fails * @param {Object} simplePromptOptions * @param {string} simplePromptOptions.promptMessage * @param {string} simplePromptOptions.fallbackPromptMessage * @returns {Promise} Promise that resolves an object with details about the biometrics result */ simplePrompt( simplePromptOptions: SimplePromptOptions, ): Promise { simplePromptOptions.cancelButtonText = simplePromptOptions.cancelButtonText ?? "Cancel"; simplePromptOptions.fallbackPromptMessage = simplePromptOptions.fallbackPromptMessage ?? "Use Passcode"; return bridge.simplePrompt({ allowDeviceCredentials: this.allowDeviceCredentials, ...simplePromptOptions, }); } }