expo-local-authentication 11.1.1 → 12.1.1

package/CHANGELOG.md

@@ -10,10 +10,33 @@
 
 ### 💡 Others
 
-## 11.1.1 — 2021-06-24
+## 12.1.1 — 2022-02-01
+
+### 🐛 Bug fixes
+
+- Fix `Plugin with id 'maven' not found` build error from Android Gradle 7. ([#16080](https://github.com/expo/expo/pull/16080) by [@kudo](https://github.com/kudo))
+
+## 12.1.0 — 2021-12-03
 
 _This version does not introduce any user-facing changes._
 
+## 12.0.0 — 2021-09-28
+
+### 🛠 Breaking changes
+
+- Dropped support for iOS 11.0 ([#14383](https://github.com/expo/expo/pull/14383) by [@cruzach](https://github.com/cruzach))
+
+### 🐛 Bug fixes
+
+- Added missing definition on type LocalAuthenticationResult. ([#13636](https://github.com/expo/expo/pull/13636) by [@mstach60161](https://github.com/mstach60161))
+- Fixed detection of the available authentication types on some Samsung devices on Android. ([#14300](https://github.com/expo/expo/pull/14300) by [@beaur](https://github.com/beaur))
+- Fix building errors from use_frameworks! in Podfile. ([#14523](https://github.com/expo/expo/pull/14523) by [@kudo](https://github.com/kudo))
+
+### 💡 Others
+
+- Rewrite module from Java to Kotlin. ([#13582](https://github.com/expo/expo/pull/13582) by [@mstach60161](https://github.com/mstach60161))
+- Updated `@expo/config-plugins` ([#14443](https://github.com/expo/expo/pull/14443) by [@EvanBacon](https://github.com/EvanBacon))
+
 ## 11.1.0 — 2021-06-16
 
 ### 🐛 Bug fixes

package/README.md

@@ -13,7 +13,7 @@ For [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/
 
 # Installation in bare React Native projects
 
-For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
 
 ### Add the package to your npm dependencies
 

package/android/build.gradle

@@ -1,9 +1,9 @@
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
-apply plugin: 'maven'
+apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '11.1.1'
+version = '12.1.1'
 
 buildscript {
   // Simple helper that allows the root project to override versions declared by this library.
@@ -20,27 +20,25 @@ buildscript {
   }
 }
 
-// Upload android library to maven with javadoc and android sources
-configurations {
-  deployerJars
-}
-
 // Creating sources with comments
 task androidSourcesJar(type: Jar) {
   classifier = 'sources'
   from android.sourceSets.main.java.srcDirs
 }
 
-// Put the androidSources and javadoc to the artifacts
-artifacts {
-  archives androidSourcesJar
-}
-
-uploadArchives {
-  repositories {
-    mavenDeployer {
-      configuration = configurations.deployerJars
-      repository(url: mavenLocal().url)
+afterEvaluate {
+  publishing {
+    publications {
+      release(MavenPublication) {
+        from components.release
+        // Add additional sourcesJar to artifacts
+        artifact(androidSourcesJar)
+      }
+    }
+    repositories {
+      maven {
+        url = mavenLocal().url
+      }
     }
   }
 }
@@ -53,27 +51,23 @@ android {
     targetCompatibility JavaVersion.VERSION_1_8
   }
 
+  kotlinOptions {
+    jvmTarget = JavaVersion.VERSION_1_8
+  }
+
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 30)
     versionCode 30
-    versionName "11.1.1"
+    versionName "12.1.1"
   }
   lintOptions {
     abortOnError false
   }
 }
 
-if (new File(rootProject.projectDir.parentFile, 'package.json').exists()) {
-  apply from: project(":unimodules-core").file("../unimodules-core.gradle")
-} else {
-  throw new GradleException(
-      "'unimodules-core.gradle' was not found in the usual React Native dependency location. " +
-          "This package can only be used in such projects. Are you sure you've installed the dependencies properly?")
-}
-
 dependencies {
-  unimodule "unimodules-core"
+  implementation project(':expo-modules-core')
 
   api "androidx.biometric:biometric:1.1.0"
 

package/android/src/main/java/expo/modules/localauthentication/LocalAuthenticationModule.kt

@@ -0,0 +1,288 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+package expo.modules.localauthentication
+
+import android.app.Activity
+import android.app.KeyguardManager
+import android.content.Context
+import android.content.Intent
+import android.os.Build
+import android.os.Bundle
+import androidx.biometric.BiometricManager
+import androidx.biometric.BiometricPrompt
+import androidx.biometric.BiometricPrompt.PromptInfo
+import androidx.fragment.app.FragmentActivity
+import expo.modules.core.ExportedModule
+import expo.modules.core.ModuleRegistry
+import expo.modules.core.ModuleRegistryDelegate
+import expo.modules.core.Promise
+import expo.modules.core.interfaces.ActivityEventListener
+import expo.modules.core.interfaces.ActivityProvider
+import expo.modules.core.interfaces.ExpoMethod
+import expo.modules.core.interfaces.services.UIManager
+import java.util.*
+import java.util.concurrent.Executor
+import java.util.concurrent.Executors
+
+class LocalAuthenticationModule(context: Context) : ExportedModule(context), ActivityEventListener {
+  private val AUTHENTICATION_TYPE_FINGERPRINT = 1
+  private val AUTHENTICATION_TYPE_FACIAL_RECOGNITION = 2
+  private val AUTHENTICATION_TYPE_IRIS = 3
+  private val SECURITY_LEVEL_NONE = 0
+  private val SECURITY_LEVEL_SECRET = 1
+  private val SECURITY_LEVEL_BIOMETRIC = 2
+  private val biometricManager = BiometricManager.from(context)
+  private val packageManager = context.packageManager
+  private var biometricPrompt: BiometricPrompt? = null
+  private var promise: Promise? = null
+  private var isAuthenticating = false
+  private val moduleRegistryDelegate: ModuleRegistryDelegate = ModuleRegistryDelegate()
+  private val uIManager: UIManager by moduleRegistry()
+
+  private inline fun <reified T> moduleRegistry() = moduleRegistryDelegate.getFromModuleRegistry<T>()
+
+  private fun convertErrorCode(code: Int): String {
+    return when (code) {
+      BiometricPrompt.ERROR_CANCELED, BiometricPrompt.ERROR_NEGATIVE_BUTTON, BiometricPrompt.ERROR_USER_CANCELED -> "user_cancel"
+      BiometricPrompt.ERROR_HW_NOT_PRESENT, BiometricPrompt.ERROR_HW_UNAVAILABLE, BiometricPrompt.ERROR_NO_BIOMETRICS, BiometricPrompt.ERROR_NO_DEVICE_CREDENTIAL -> "not_available"
+      BiometricPrompt.ERROR_LOCKOUT, BiometricPrompt.ERROR_LOCKOUT_PERMANENT -> "lockout"
+      BiometricPrompt.ERROR_NO_SPACE -> "no_space"
+      BiometricPrompt.ERROR_TIMEOUT -> "timeout"
+      BiometricPrompt.ERROR_UNABLE_TO_PROCESS -> "unable_to_process"
+      else -> "unknown"
+    }
+  }
+
+  private val authenticationCallback: BiometricPrompt.AuthenticationCallback = object : BiometricPrompt.AuthenticationCallback() {
+    override fun onAuthenticationSucceeded(result: BiometricPrompt.AuthenticationResult) {
+      isAuthenticating = false
+      biometricPrompt = null
+      promise?.resolve(
+        Bundle().apply {
+          putBoolean("success", true)
+        }
+      )
+      promise = null
+    }
+
+    override fun onAuthenticationError(errMsgId: Int, errString: CharSequence) {
+      isAuthenticating = false
+      biometricPrompt = null
+      promise?.resolve(
+        Bundle().apply {
+          putBoolean("success", false)
+          putString("error", convertErrorCode(errMsgId))
+          putString("warning", errString.toString())
+        }
+      )
+      promise = null
+    }
+  }
+
+  override fun getName(): String {
+    return "ExpoLocalAuthentication"
+  }
+
+  override fun onCreate(moduleRegistry: ModuleRegistry) {
+    moduleRegistryDelegate.onCreate(moduleRegistry)
+    uIManager.registerActivityEventListener(this)
+  }
+
+  @ExpoMethod
+  fun supportedAuthenticationTypesAsync(promise: Promise) {
+    val result = biometricManager.canAuthenticate(BiometricManager.Authenticators.BIOMETRIC_WEAK)
+    val results: MutableList<Int> = ArrayList()
+    if (result == BiometricManager.BIOMETRIC_ERROR_NO_HARDWARE) {
+      promise.resolve(results)
+      return
+    }
+
+    // note(cedric): replace hardcoded system feature strings with constants from
+    // PackageManager when dropping support for Android SDK 28
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+      if (packageManager.hasSystemFeature("android.hardware.fingerprint")) {
+        results.add(AUTHENTICATION_TYPE_FINGERPRINT)
+      }
+    }
+    if (Build.VERSION.SDK_INT >= 29) {
+      if (packageManager.hasSystemFeature("android.hardware.biometrics.face")) {
+        results.add(AUTHENTICATION_TYPE_FACIAL_RECOGNITION)
+      }
+      if (packageManager.hasSystemFeature("android.hardware.biometrics.iris")) {
+        results.add(AUTHENTICATION_TYPE_IRIS)
+      }
+    }
+
+    // check for face recognition support on some samsung devices
+    if (packageManager.hasSystemFeature("com.samsung.android.bio.face") && !results.contains(AUTHENTICATION_TYPE_FACIAL_RECOGNITION)) {
+      results.add(AUTHENTICATION_TYPE_FACIAL_RECOGNITION)
+    }
+
+    promise.resolve(results)
+  }
+
+  @ExpoMethod
+  fun hasHardwareAsync(promise: Promise) {
+    val result = biometricManager.canAuthenticate(BiometricManager.Authenticators.BIOMETRIC_WEAK)
+    promise.resolve(result != BiometricManager.BIOMETRIC_ERROR_NO_HARDWARE)
+  }
+
+  @ExpoMethod
+  fun isEnrolledAsync(promise: Promise) {
+    val result = biometricManager.canAuthenticate(BiometricManager.Authenticators.BIOMETRIC_WEAK)
+    promise.resolve(result == BiometricManager.BIOMETRIC_SUCCESS)
+  }
+
+  @ExpoMethod
+  fun getEnrolledLevelAsync(promise: Promise) {
+    var level = SECURITY_LEVEL_NONE
+    if (isDeviceSecure) {
+      level = SECURITY_LEVEL_SECRET
+    }
+    val result = biometricManager.canAuthenticate(BiometricManager.Authenticators.BIOMETRIC_WEAK)
+    if (result == BiometricManager.BIOMETRIC_SUCCESS) {
+      level = SECURITY_LEVEL_BIOMETRIC
+    }
+    promise.resolve(level)
+  }
+
+  @ExpoMethod
+  fun authenticateAsync(options: Map<String?, Any?>, promise: Promise) {
+    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.M) {
+      promise.reject("E_NOT_SUPPORTED", "Cannot display biometric prompt on android versions below 6.0")
+      return
+    }
+    if (currentActivity == null) {
+      promise.reject("E_NOT_FOREGROUND", "Cannot display biometric prompt when the app is not in the foreground")
+      return
+    }
+    if (!keyguardManager.isDeviceSecure) {
+      promise.resolve(
+        Bundle().apply {
+          putBoolean("success", false)
+          putString("error", "not_enrolled")
+          putString("warning", "KeyguardManager#isDeviceSecure() returned false")
+        }
+      )
+      return
+    }
+    val fragmentActivity = currentActivity as FragmentActivity?
+    if (fragmentActivity == null) {
+      promise.resolve(
+        Bundle().apply {
+          putBoolean("success", false)
+          putString("error", "not_available")
+          putString("warning", "getCurrentActivity() returned null")
+        }
+      )
+      return
+    }
+
+    // BiometricPrompt callbacks are invoked on the main thread so also run this there to avoid
+    // having to do locking.
+    uIManager.runOnUiQueueThread(
+      Runnable {
+        if (isAuthenticating) {
+          this.promise?.resolve(
+            Bundle().apply {
+              putBoolean("success", false)
+              putString("error", "app_cancel")
+            }
+          )
+          this.promise = promise
+          return@Runnable
+        }
+        val promptMessage = if (options.containsKey("promptMessage")) {
+          options["promptMessage"] as String?
+        } else {
+          ""
+        }
+        val cancelLabel = if (options.containsKey("cancelLabel")) {
+          options["cancelLabel"] as String?
+        } else {
+          ""
+        }
+        val disableDeviceFallback = if (options.containsKey("disableDeviceFallback")) {
+          options["disableDeviceFallback"] as Boolean?
+        } else {
+          false
+        }
+        isAuthenticating = true
+        this.promise = promise
+        val executor: Executor = Executors.newSingleThreadExecutor()
+        biometricPrompt = BiometricPrompt(fragmentActivity, executor, authenticationCallback)
+        val promptInfoBuilder = PromptInfo.Builder()
+        promptMessage?.let {
+          promptInfoBuilder.setTitle(it)
+        }
+        if (disableDeviceFallback == true) {
+          cancelLabel?.let {
+            promptInfoBuilder.setNegativeButtonText(it)
+          }
+        } else {
+          promptInfoBuilder.setAllowedAuthenticators(
+            BiometricManager.Authenticators.BIOMETRIC_WEAK
+              or BiometricManager.Authenticators.DEVICE_CREDENTIAL
+          )
+        }
+        val promptInfo = promptInfoBuilder.build()
+        try {
+          biometricPrompt!!.authenticate(promptInfo)
+        } catch (ex: NullPointerException) {
+          promise.reject("E_INTERNAL_ERRROR", "Canceled authentication due to an internal error")
+        }
+      }
+    )
+  }
+
+  @ExpoMethod
+  fun cancelAuthenticate(promise: Promise) {
+    uIManager.runOnUiQueueThread {
+      biometricPrompt?.cancelAuthentication()
+      isAuthenticating = false
+      promise.resolve(null)
+    }
+  }
+
+  override fun onActivityResult(activity: Activity, requestCode: Int, resultCode: Int, data: Intent?) {
+    // If the user uses PIN as an authentication method, the result will be passed to the `onActivityResult`.
+    // Unfortunately, react-native doesn't pass this value to the underlying fragment - we won't resolve the promise.
+    // So we need to do it manually.
+    if (activity is FragmentActivity) {
+      val fragment = activity.supportFragmentManager.findFragmentByTag("androidx.biometric.BiometricFragment")
+      fragment?.onActivityResult(requestCode and 0xffff, resultCode, data)
+    }
+  }
+
+  override fun onNewIntent(intent: Intent) = Unit
+
+  // NOTE: `KeyguardManager#isKeyguardSecure()` considers SIM locked state,
+  // but it will be ignored on falling-back to device credential on biometric authentication.
+  // That means, setting level to `SECURITY_LEVEL_SECRET` might be misleading for some users.
+  // But there is no equivalent APIs prior to M.
+  // `andriodx.biometric.BiometricManager#canAuthenticate(int)` looks like an alternative,
+  // but specifying `BiometricManager.Authenticators.DEVICE_CREDENTIAL` alone is not
+  // supported prior to API 30.
+  // https://developer.android.com/reference/androidx/biometric/BiometricManager#canAuthenticate(int)
+  private val isDeviceSecure: Boolean
+    get() = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+      keyguardManager.isDeviceSecure
+    } else {
+      // NOTE: `KeyguardManager#isKeyguardSecure()` considers SIM locked state,
+      // but it will be ignored on falling-back to device credential on biometric authentication.
+      // That means, setting level to `SECURITY_LEVEL_SECRET` might be misleading for some users.
+      // But there is no equivalent APIs prior to M.
+      // `andriodx.biometric.BiometricManager#canAuthenticate(int)` looks like an alternative,
+      // but specifying `BiometricManager.Authenticators.DEVICE_CREDENTIAL` alone is not
+      // supported prior to API 30.
+      // https://developer.android.com/reference/androidx/biometric/BiometricManager#canAuthenticate(int)
+      keyguardManager.isKeyguardSecure
+    }
+
+  private val keyguardManager: KeyguardManager
+    get() = context.getSystemService(Context.KEYGUARD_SERVICE) as KeyguardManager
+  private val currentActivity: Activity?
+    get() {
+      val activityProvider: ActivityProvider by moduleRegistry()
+      return activityProvider.currentActivity
+    }
+}

package/android/src/main/java/expo/modules/localauthentication/LocalAuthenticationPackage.kt

@@ -0,0 +1,11 @@
+package expo.modules.localauthentication
+
+import android.content.Context
+import expo.modules.core.BasePackage
+import expo.modules.core.ExportedModule
+
+class LocalAuthenticationPackage : BasePackage() {
+  override fun createExportedModules(context: Context): List<ExportedModule> {
+    return listOf<ExportedModule>(LocalAuthenticationModule(context))
+  }
+}

package/build/ExpoLocalAuthentication.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@unimodules/core").ProxyNativeModule;
+declare const _default: import("expo-modules-core").ProxyNativeModule;
 export default _default;

package/build/ExpoLocalAuthentication.js

@@ -1,3 +1,3 @@
-import { NativeModulesProxy } from '@unimodules/core';
+import { NativeModulesProxy } from 'expo-modules-core';
 export default NativeModulesProxy.ExpoLocalAuthentication;
 //# sourceMappingURL=ExpoLocalAuthentication.js.map

package/build/ExpoLocalAuthentication.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoLocalAuthentication.js","sourceRoot":"","sources":["../src/ExpoLocalAuthentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,eAAe,kBAAkB,CAAC,uBAAuB,CAAC","sourcesContent":["import { NativeModulesProxy } from '@unimodules/core';\n\nexport default NativeModulesProxy.ExpoLocalAuthentication;\n"]}
+{"version":3,"file":"ExpoLocalAuthentication.js","sourceRoot":"","sources":["../src/ExpoLocalAuthentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,eAAe,kBAAkB,CAAC,uBAAuB,CAAC","sourcesContent":["import { NativeModulesProxy } from 'expo-modules-core';\n\nexport default NativeModulesProxy.ExpoLocalAuthentication;\n"]}

package/build/LocalAuthentication.d.ts

@@ -1,8 +1,44 @@
 import { LocalAuthenticationOptions, AuthenticationType, LocalAuthenticationResult, SecurityLevel } from './LocalAuthentication.types';
 export { LocalAuthenticationOptions, AuthenticationType, LocalAuthenticationResult, SecurityLevel };
+/**
+ * Determine whether a face or fingerprint scanner is available on the device.
+ * @return Returns a promise which fulfils with a `boolean` value indicating whether a face or
+ * fingerprint scanner is available on this device.
+ */
 export declare function hasHardwareAsync(): Promise<boolean>;
+/**
+ * Determine what kinds of authentications are available on the device.
+ * @return Returns a promise which fulfils to an array containing [`AuthenticationType`s](#authenticationtype).
+ *
+ * Devices can support multiple authentication methods- i.e. `[1,2]` means the device supports both
+ * fingerprint and facial recognition. If none are supported, this method returns an empty array.
+ */
 export declare function supportedAuthenticationTypesAsync(): Promise<AuthenticationType[]>;
+/**
+ * Determine whether the device has saved fingerprints or facial data to use for authentication.
+ * @return Returns a promise which fulfils to `boolean` value indicating whether the device has
+ * saved fingerprints or facial data for authentication.
+ */
 export declare function isEnrolledAsync(): Promise<boolean>;
+/**
+ * Determine what kind of authentication is enrolled on the device.
+ * @return Returns a promise which fulfils with [`SecurityLevel`](#securitylevel).
+ * > **Note:** On Android devices prior to M, `SECRET` can be returned if only the SIM lock has been
+ * enrolled, which is not the method that [`authenticateAsync`](#localauthenticationauthenticateasyncoptions)
+ * prompts.
+ */
 export declare function getEnrolledLevelAsync(): Promise<SecurityLevel>;
+/**
+ * Attempts to authenticate via Fingerprint/TouchID (or FaceID if available on the device).
+ * > **Note:** Apple requires apps which use FaceID to provide a description of why they use this API.
+ * If you try to use FaceID on an iPhone with FaceID without providing `infoPlist.NSFaceIDUsageDescription`
+ * in `app.json`, the module will authenticate using device passcode. For more information about
+ * usage descriptions on iOS, see [Deploying to App Stores](/distribution/app-stores#system-permissions-dialogs-on-ios).
+ * @param options
+ * @return Returns a promise which fulfils with [`LocalAuthenticationResult`](#localauthenticationresult).
+ */
 export declare function authenticateAsync(options?: LocalAuthenticationOptions): Promise<LocalAuthenticationResult>;
+/**
+ * **(Android Only)** Cancels authentication flow.
+ */
 export declare function cancelAuthenticate(): Promise<void>;

package/build/LocalAuthentication.js

@@ -1,32 +1,70 @@
-import { UnavailabilityError } from '@unimodules/core';
+import { UnavailabilityError } from 'expo-modules-core';
 import invariant from 'invariant';
 import ExpoLocalAuthentication from './ExpoLocalAuthentication';
 import { AuthenticationType, SecurityLevel, } from './LocalAuthentication.types';
 export { AuthenticationType, SecurityLevel };
+// @needsAudit
+/**
+ * Determine whether a face or fingerprint scanner is available on the device.
+ * @return Returns a promise which fulfils with a `boolean` value indicating whether a face or
+ * fingerprint scanner is available on this device.
+ */
 export async function hasHardwareAsync() {
     if (!ExpoLocalAuthentication.hasHardwareAsync) {
         throw new UnavailabilityError('expo-local-authentication', 'hasHardwareAsync');
     }
     return await ExpoLocalAuthentication.hasHardwareAsync();
 }
+// @needsAudit
+/**
+ * Determine what kinds of authentications are available on the device.
+ * @return Returns a promise which fulfils to an array containing [`AuthenticationType`s](#authenticationtype).
+ *
+ * Devices can support multiple authentication methods- i.e. `[1,2]` means the device supports both
+ * fingerprint and facial recognition. If none are supported, this method returns an empty array.
+ */
 export async function supportedAuthenticationTypesAsync() {
     if (!ExpoLocalAuthentication.supportedAuthenticationTypesAsync) {
         throw new UnavailabilityError('expo-local-authentication', 'supportedAuthenticationTypesAsync');
     }
     return await ExpoLocalAuthentication.supportedAuthenticationTypesAsync();
 }
+// @needsAudit
+/**
+ * Determine whether the device has saved fingerprints or facial data to use for authentication.
+ * @return Returns a promise which fulfils to `boolean` value indicating whether the device has
+ * saved fingerprints or facial data for authentication.
+ */
 export async function isEnrolledAsync() {
     if (!ExpoLocalAuthentication.isEnrolledAsync) {
         throw new UnavailabilityError('expo-local-authentication', 'isEnrolledAsync');
     }
     return await ExpoLocalAuthentication.isEnrolledAsync();
 }
+// @needsAudit
+/**
+ * Determine what kind of authentication is enrolled on the device.
+ * @return Returns a promise which fulfils with [`SecurityLevel`](#securitylevel).
+ * > **Note:** On Android devices prior to M, `SECRET` can be returned if only the SIM lock has been
+ * enrolled, which is not the method that [`authenticateAsync`](#localauthenticationauthenticateasyncoptions)
+ * prompts.
+ */
 export async function getEnrolledLevelAsync() {
     if (!ExpoLocalAuthentication.getEnrolledLevelAsync) {
         throw new UnavailabilityError('expo-local-authentication', 'getEnrolledLevelAsync');
     }
     return await ExpoLocalAuthentication.getEnrolledLevelAsync();
 }
+// @needsAudit
+/**
+ * Attempts to authenticate via Fingerprint/TouchID (or FaceID if available on the device).
+ * > **Note:** Apple requires apps which use FaceID to provide a description of why they use this API.
+ * If you try to use FaceID on an iPhone with FaceID without providing `infoPlist.NSFaceIDUsageDescription`
+ * in `app.json`, the module will authenticate using device passcode. For more information about
+ * usage descriptions on iOS, see [Deploying to App Stores](/distribution/app-stores#system-permissions-dialogs-on-ios).
+ * @param options
+ * @return Returns a promise which fulfils with [`LocalAuthenticationResult`](#localauthenticationresult).
+ */
 export async function authenticateAsync(options = {}) {
     if (!ExpoLocalAuthentication.authenticateAsync) {
         throw new UnavailabilityError('expo-local-authentication', 'authenticateAsync');
@@ -41,6 +79,10 @@ export async function authenticateAsync(options = {}) {
     }
     return result;
 }
+// @needsAudit
+/**
+ * **(Android Only)** Cancels authentication flow.
+ */
 export async function cancelAuthenticate() {
     if (!ExpoLocalAuthentication.cancelAuthenticate) {
         throw new UnavailabilityError('expo-local-authentication', 'cancelAuthenticate');

package/build/LocalAuthentication.js.map

@@ -1 +1 @@
-{"version":3,"file":"LocalAuthentication.js","sourceRoot":"","sources":["../src/LocalAuthentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAEL,kBAAkB,EAElB,aAAa,GACd,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAA8B,kBAAkB,EAA6B,aAAa,EAAE,CAAC;AAEpG,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,EAAE;QAC7C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAAC;KAChF;IACD,OAAO,MAAM,uBAAuB,CAAC,gBAAgB,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iCAAiC;IACrD,IAAI,CAAC,uBAAuB,CAAC,iCAAiC,EAAE;QAC9D,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,mCAAmC,CAAC,CAAC;KACjG;IACD,OAAO,MAAM,uBAAuB,CAAC,iCAAiC,EAAE,CAAC;AAC3E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE;QAC5C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,iBAAiB,CAAC,CAAC;KAC/E;IACD,OAAO,MAAM,uBAAuB,CAAC,eAAe,EAAE,CAAC;AACzD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,IAAI,CAAC,uBAAuB,CAAC,qBAAqB,EAAE;QAClD,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,uBAAuB,CAAC,CAAC;KACrF;IACD,OAAO,MAAM,uBAAuB,CAAC,qBAAqB,EAAE,CAAC;AAC/D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAsC,EAAE;IAExC,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE;QAC9C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAC;KACjF;IAED,IAAI,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;QAC3C,SAAS,CACP,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EACzE,6FAA6F,CAC9F,CAAC;KACH;IAED,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC;IAC9D,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;IAE9F,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;KAC9B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACtC,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,EAAE;QAC/C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,CAAC;KAClF;IACD,MAAM,uBAAuB,CAAC,kBAAkB,EAAE,CAAC;AACrD,CAAC","sourcesContent":["import { UnavailabilityError } from '@unimodules/core';\nimport invariant from 'invariant';\n\nimport ExpoLocalAuthentication from './ExpoLocalAuthentication';\nimport {\n  LocalAuthenticationOptions,\n  AuthenticationType,\n  LocalAuthenticationResult,\n  SecurityLevel,\n} from './LocalAuthentication.types';\n\nexport { LocalAuthenticationOptions, AuthenticationType, LocalAuthenticationResult, SecurityLevel };\n\nexport async function hasHardwareAsync(): Promise<boolean> {\n  if (!ExpoLocalAuthentication.hasHardwareAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'hasHardwareAsync');\n  }\n  return await ExpoLocalAuthentication.hasHardwareAsync();\n}\n\nexport async function supportedAuthenticationTypesAsync(): Promise<AuthenticationType[]> {\n  if (!ExpoLocalAuthentication.supportedAuthenticationTypesAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'supportedAuthenticationTypesAsync');\n  }\n  return await ExpoLocalAuthentication.supportedAuthenticationTypesAsync();\n}\n\nexport async function isEnrolledAsync(): Promise<boolean> {\n  if (!ExpoLocalAuthentication.isEnrolledAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'isEnrolledAsync');\n  }\n  return await ExpoLocalAuthentication.isEnrolledAsync();\n}\n\nexport async function getEnrolledLevelAsync(): Promise<SecurityLevel> {\n  if (!ExpoLocalAuthentication.getEnrolledLevelAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'getEnrolledLevelAsync');\n  }\n  return await ExpoLocalAuthentication.getEnrolledLevelAsync();\n}\n\nexport async function authenticateAsync(\n  options: LocalAuthenticationOptions = {}\n): Promise<LocalAuthenticationResult> {\n  if (!ExpoLocalAuthentication.authenticateAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'authenticateAsync');\n  }\n\n  if (options.hasOwnProperty('promptMessage')) {\n    invariant(\n      typeof options.promptMessage === 'string' && options.promptMessage.length,\n      'LocalAuthentication.authenticateAsync : `options.promptMessage` must be a non-empty string.'\n    );\n  }\n\n  const promptMessage = options.promptMessage || 'Authenticate';\n  const result = await ExpoLocalAuthentication.authenticateAsync({ ...options, promptMessage });\n\n  if (result.warning) {\n    console.warn(result.warning);\n  }\n  return result;\n}\n\nexport async function cancelAuthenticate(): Promise<void> {\n  if (!ExpoLocalAuthentication.cancelAuthenticate) {\n    throw new UnavailabilityError('expo-local-authentication', 'cancelAuthenticate');\n  }\n  await ExpoLocalAuthentication.cancelAuthenticate();\n}\n"]}
+{"version":3,"file":"LocalAuthentication.js","sourceRoot":"","sources":["../src/LocalAuthentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAEL,kBAAkB,EAElB,aAAa,GACd,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAA8B,kBAAkB,EAA6B,aAAa,EAAE,CAAC;AAEpG,cAAc;AACd;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,EAAE;QAC7C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAAC;KAChF;IACD,OAAO,MAAM,uBAAuB,CAAC,gBAAgB,EAAE,CAAC;AAC1D,CAAC;AAED,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC;IACrD,IAAI,CAAC,uBAAuB,CAAC,iCAAiC,EAAE;QAC9D,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,mCAAmC,CAAC,CAAC;KACjG;IACD,OAAO,MAAM,uBAAuB,CAAC,iCAAiC,EAAE,CAAC;AAC3E,CAAC;AAED,cAAc;AACd;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE;QAC5C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,iBAAiB,CAAC,CAAC;KAC/E;IACD,OAAO,MAAM,uBAAuB,CAAC,eAAe,EAAE,CAAC;AACzD,CAAC;AAED,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,IAAI,CAAC,uBAAuB,CAAC,qBAAqB,EAAE;QAClD,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,uBAAuB,CAAC,CAAC;KACrF;IACD,OAAO,MAAM,uBAAuB,CAAC,qBAAqB,EAAE,CAAC;AAC/D,CAAC;AAED,cAAc;AACd;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAsC,EAAE;IAExC,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE;QAC9C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAC;KACjF;IAED,IAAI,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;QAC3C,SAAS,CACP,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EACzE,6FAA6F,CAC9F,CAAC;KACH;IAED,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC;IAC9D,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;IAE9F,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;KAC9B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,cAAc;AACd;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACtC,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,EAAE;QAC/C,MAAM,IAAI,mBAAmB,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,CAAC;KAClF;IACD,MAAM,uBAAuB,CAAC,kBAAkB,EAAE,CAAC;AACrD,CAAC","sourcesContent":["import { UnavailabilityError } from 'expo-modules-core';\nimport invariant from 'invariant';\n\nimport ExpoLocalAuthentication from './ExpoLocalAuthentication';\nimport {\n  LocalAuthenticationOptions,\n  AuthenticationType,\n  LocalAuthenticationResult,\n  SecurityLevel,\n} from './LocalAuthentication.types';\n\nexport { LocalAuthenticationOptions, AuthenticationType, LocalAuthenticationResult, SecurityLevel };\n\n// @needsAudit\n/**\n * Determine whether a face or fingerprint scanner is available on the device.\n * @return Returns a promise which fulfils with a `boolean` value indicating whether a face or\n * fingerprint scanner is available on this device.\n */\nexport async function hasHardwareAsync(): Promise<boolean> {\n  if (!ExpoLocalAuthentication.hasHardwareAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'hasHardwareAsync');\n  }\n  return await ExpoLocalAuthentication.hasHardwareAsync();\n}\n\n// @needsAudit\n/**\n * Determine what kinds of authentications are available on the device.\n * @return Returns a promise which fulfils to an array containing [`AuthenticationType`s](#authenticationtype).\n *\n * Devices can support multiple authentication methods- i.e. `[1,2]` means the device supports both\n * fingerprint and facial recognition. If none are supported, this method returns an empty array.\n */\nexport async function supportedAuthenticationTypesAsync(): Promise<AuthenticationType[]> {\n  if (!ExpoLocalAuthentication.supportedAuthenticationTypesAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'supportedAuthenticationTypesAsync');\n  }\n  return await ExpoLocalAuthentication.supportedAuthenticationTypesAsync();\n}\n\n// @needsAudit\n/**\n * Determine whether the device has saved fingerprints or facial data to use for authentication.\n * @return Returns a promise which fulfils to `boolean` value indicating whether the device has\n * saved fingerprints or facial data for authentication.\n */\nexport async function isEnrolledAsync(): Promise<boolean> {\n  if (!ExpoLocalAuthentication.isEnrolledAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'isEnrolledAsync');\n  }\n  return await ExpoLocalAuthentication.isEnrolledAsync();\n}\n\n// @needsAudit\n/**\n * Determine what kind of authentication is enrolled on the device.\n * @return Returns a promise which fulfils with [`SecurityLevel`](#securitylevel).\n * > **Note:** On Android devices prior to M, `SECRET` can be returned if only the SIM lock has been\n * enrolled, which is not the method that [`authenticateAsync`](#localauthenticationauthenticateasyncoptions)\n * prompts.\n */\nexport async function getEnrolledLevelAsync(): Promise<SecurityLevel> {\n  if (!ExpoLocalAuthentication.getEnrolledLevelAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'getEnrolledLevelAsync');\n  }\n  return await ExpoLocalAuthentication.getEnrolledLevelAsync();\n}\n\n// @needsAudit\n/**\n * Attempts to authenticate via Fingerprint/TouchID (or FaceID if available on the device).\n * > **Note:** Apple requires apps which use FaceID to provide a description of why they use this API.\n * If you try to use FaceID on an iPhone with FaceID without providing `infoPlist.NSFaceIDUsageDescription`\n * in `app.json`, the module will authenticate using device passcode. For more information about\n * usage descriptions on iOS, see [Deploying to App Stores](/distribution/app-stores#system-permissions-dialogs-on-ios).\n * @param options\n * @return Returns a promise which fulfils with [`LocalAuthenticationResult`](#localauthenticationresult).\n */\nexport async function authenticateAsync(\n  options: LocalAuthenticationOptions = {}\n): Promise<LocalAuthenticationResult> {\n  if (!ExpoLocalAuthentication.authenticateAsync) {\n    throw new UnavailabilityError('expo-local-authentication', 'authenticateAsync');\n  }\n\n  if (options.hasOwnProperty('promptMessage')) {\n    invariant(\n      typeof options.promptMessage === 'string' && options.promptMessage.length,\n      'LocalAuthentication.authenticateAsync : `options.promptMessage` must be a non-empty string.'\n    );\n  }\n\n  const promptMessage = options.promptMessage || 'Authenticate';\n  const result = await ExpoLocalAuthentication.authenticateAsync({ ...options, promptMessage });\n\n  if (result.warning) {\n    console.warn(result.warning);\n  }\n  return result;\n}\n\n// @needsAudit\n/**\n * **(Android Only)** Cancels authentication flow.\n */\nexport async function cancelAuthenticate(): Promise<void> {\n  if (!ExpoLocalAuthentication.cancelAuthenticate) {\n    throw new UnavailabilityError('expo-local-authentication', 'cancelAuthenticate');\n  }\n  await ExpoLocalAuthentication.cancelAuthenticate();\n}\n"]}

package/build/LocalAuthentication.types.d.ts

@@ -3,20 +3,60 @@ export declare type LocalAuthenticationResult = {
 } | {
     success: false;
     error: string;
+    warning?: string;
 };
 export declare enum AuthenticationType {
+    /**
+     * Indicates fingerprint support.
+     */
     FINGERPRINT = 1,
+    /**
+     * Indicates facial recognition support.
+     */
     FACIAL_RECOGNITION = 2,
+    /**
+     * Indicates iris recognition support.
+     * @platform android
+     */
     IRIS = 3
 }
 export declare enum SecurityLevel {
+    /**
+     * Indicates no enrolled authentication.
+     */
     NONE = 0,
+    /**
+     * Indicates non-biometric authentication (e.g. PIN, Pattern).
+     */
     SECRET = 1,
+    /**
+     * Indicates biometric authentication.
+     */
     BIOMETRIC = 2
 }
 export declare type LocalAuthenticationOptions = {
+    /**
+     * A message that is shown alongside the TouchID or FaceID prompt.
+     */
     promptMessage?: string;
+    /**
+     * Allows to customize the default `Cancel` label shown.
+     */
     cancelLabel?: string;
+    /**
+     * After several failed attempts the system will fallback to the device passcode. This setting
+     * allows you to disable this option and instead handle the fallback yourself. This can be
+     * preferable in certain custom authentication workflows. This behaviour maps to using the iOS
+     * [LAPolicyDeviceOwnerAuthenticationWithBiometrics](https://developer.apple.com/documentation/localauthentication/lapolicy/lapolicydeviceownerauthenticationwithbiometrics?language=objc)
+     * policy rather than the [LAPolicyDeviceOwnerAuthentication](https://developer.apple.com/documentation/localauthentication/lapolicy/lapolicydeviceownerauthentication?language=objc)
+     * policy. Defaults to `false`.
+     */
     disableDeviceFallback?: boolean;
+    /**
+     * Allows to customize the default `Use Passcode` label shown after several failed
+     * authentication attempts. Setting this option to an empty string disables this button from
+     * showing in the prompt.
+     * @platform ios
+     */
     fallbackLabel?: string;
 };