arcane_framework/lib/src/services/authentication/authentication_enums.dart

part of "authentication_service.dart";

/// An enum representing the different steps in the sign-up process.
///
/// This enum has two possible values:
/// - `confirmSignUp`: The user needs to confirm the sign-up process.
/// - `done`: The sign-up process is complete.
///
/// Example:
/// ```dart
/// SignUpStep step = SignUpStep.confirmSignUp;
/// if (step == SignUpStep.done) {
///   // Sign-up process is finished
/// }
/// ```
enum SignUpStep {
  /// The step where the user needs to confirm their sign-up,
  /// typically through email or other verification methods.
  confirmSignUp,

  /// The sign-up process is complete.
  done,
}

/// An enum representing the authentication status of a user.
///
/// This enum has three possible states:
/// - `authenticated`: The user is authenticated.
/// - `unauthenticated`: The user is not authenticated.
/// - `debug`: The application is in debug mode for testing.
///
/// Example:
/// ```dart
/// AuthenticationStatus status = AuthenticationStatus.authenticated;
/// if (status.isAuthenticated) {
///   // User is authenticated
/// }
/// ```
enum AuthenticationStatus {
  /// The user is authenticated.
  authenticated,

  /// The user is not authenticated.
  unauthenticated,

  /// The application is in debug mode, typically for testing or development purposes.
  debug;

  /// Returns `true` if the current status is `debug`.
  bool get isDebug => this == debug;

  /// Returns `true` if the current status is `authenticated`.
  bool get isAuthenticated => this == authenticated;

  /// Returns `true` if the current status is `unauthenticated`.
  bool get isUnauthenticated => this == unauthenticated;
}

/// An enum representing the different application environments.
///
/// This enum has two possible values:
/// - `debug`: The application is in debug mode, typically for development and testing.
/// - `normal`: The application is running in a normal mode, for production or standard use.
enum Environment {
  /// The debug environment for development and testing purposes.
  debug,

  /// The normal environment for production use.
  normal,
}