API Reference

API Reference

This section provides detailed documentation for Lumo’s core classes, methods, and utilities.

Core Classes

OtpEntry

The main entity representing a single OTP account.

class OtpEntry {
  final String id;
  final String issuer;
  final String account;
  final String secret;
  final OtpAlgorithm algorithm;
  final int digits;
  final int interval;
  final OtpType type;
  final int? counter;
  final DateTime created;
  final DateTime? lastUsed;

  // Generate OTP code for current time
  String generateOtp();

  // Get remaining time in seconds (TOTP only)
  int getRemainingTime();

  // Create a copy with modified fields
  OtpEntry copyWith({...});
}

OtpRepository

Interface for OTP data operations.

abstract class OtpRepository {
  Future<Either<Failure, List<OtpEntry>>> getAllOtpEntries();
  Future<Either<Failure, void>> addOtpEntry(OtpEntry entry);
  Future<Either<Failure, void>> updateOtpEntry(OtpEntry entry);
  Future<Either<Failure, void>> deleteOtpEntry(String id);
  Future<Either<Failure, void>> clearAllOtpEntries();
}

Utility Classes

OtpUtils

Static methods for OTP generation and validation.

class OtpUtils {
  // Generate TOTP code
  static String generateTotp({
    required String secret,
    required OtpAlgorithm algorithm,
    required int digits,
    required int interval,
  });

  // Generate HOTP code
  static String generateHotp({
    required String secret,
    required int counter,
    required OtpAlgorithm algorithm,
    required int digits,
  });

  // Validate Base32 secret
  static bool isValidSecret(String secret);
}

OtpUriParser

Parse and validate OTP URIs.

class OtpUriParser {
  // Check if URI is valid OTP format
  static bool isValidUri(String uri);

  // Parse URI to OtpEntry
  static OtpEntry parseUri(String uri);

  // Parse label component
  static Map<String, String> parseLabel(String label);
}

State Management

Riverpod Providers

Key providers for state management.

// OTP list provider
final otpListProvider = StateNotifierProvider<OtpListNotifier, AsyncValue<List<OtpEntry>>>();

// Settings provider
final appSettingsProvider = StateNotifierProvider<AppSettingsNotifier, AsyncValue<SettingsEntity>>();

// Authentication provider
final authStateProvider = StateNotifierProvider<AuthStateNotifier, AsyncValue<AuthStatus>>();

Enums and Constants

OtpType

enum OtpType {
  totp, // Time-based OTP
  hotp, // HMAC-based OTP
}

OtpAlgorithm

enum OtpAlgorithm {
  sha1,
  sha256,
  sha512,
}

App Constants

class AppConstants {
  static const String appName = 'Lumo';
  static const int defaultDigits = 6;
  static const int defaultInterval = 30;
  static const String defaultAlgorithm = 'SHA1';
}

For detailed implementation examples, see the Architecture Overview and Development Guide.