local_auth

• Applications built with older versions of Flutter will continue to use compatible versions of the platform implementations.

• Throws LocalAuthExceptions rather than PlatformExceptions for most failures cases, allowing structured error handling using the specific LocalAuthExceptionCode values.
• Replaces AuthenticationOptions in authenticate with specific parameters.
  • AuthenticationOptions.stickyAuth corresponds to persistAcrossBackgrounding.
  • AuthenticationOptions.useErrorDialogs has no replacement, as specific error-handling UI should be up to plugin clients to determine. Callers should use the new structured error codes to detect and handle failure modes that used to have native dialogs.

• Clients directly importing local_auth_ios for auth strings should switch dependencies and imports to local_auth_darwin. No other change is necessary.

Migrates plugin to federated architecture.

Adds OS version support information to README.

BREAKING CHANGE: Deprecated method authenticateWithBiometrics has been removed. Use authenticate instead.

BREAKING CHANGE: Enum BiometricType has been expanded with options for strong and weak, and applications should be updated to handle these accordingly.

BREAKING CHANGE: Parameters of authenticate have been changed.

Example:

// Old way of calling `authenticate`.
Future<bool> authenticate(
  localizedReason: 'localized reason',
  useErrorDialogs: true,
  stickyAuth: false,
  androidAuthStrings: const AndroidAuthMessages(),
  iOSAuthStrings: const IOSAuthMessages(),
  sensitiveTransaction: true,
  biometricOnly: false,
);
// New way of calling `authenticate`.
Future<bool> authenticate(
  localizedReason: 'localized reason',
  authMessages: const <AuthMessages>[
    IOSAuthMessages(),
    AndroidAuthMessages()
  ],
  options: const AuthenticationOptions(
    useErrorDialogs: true,
    stickyAuth: false,
    sensitiveTransaction: true,
    biometricOnly: false,
  ),
);

• fingerprintHint is now biometricHint
• fingerprintNotRecognizedis now biometricNotRecognized
• fingerprintSuccessis now biometricSuccess
• fingerprintRequiredTitle is now biometricRequiredTitle