Domain models

The domain layer contains all the core business models that represent the data structures used throughout the Nimaz application. These models are organized by feature area and include Quran, Prayer, Hadith, Dua, and other Islamic utilities.

Quran models

Models for Quran reading, navigation, and bookmarking.

Surah

Represents a chapter of the Quran.

data class Surah(
    val number: Int,
    val nameArabic: String,
    val nameEnglish: String,
    val nameTransliteration: String,
    val revelationType: RevelationType,
    val ayahCount: Int,
    val juzStart: Int,
    val orderInMushaf: Int
)

number

Int

The surah number (1-114)

nameArabic

String

Arabic name of the surah

nameEnglish

String

English translation of the surah name

revelationType

RevelationType

Whether the surah was revealed in Mecca or Medina

Ayah

Represents a verse of the Quran.

data class Ayah(
    val id: Int,
    val surahNumber: Int,
    val ayahNumber: Int,
    val textArabic: String,
    val textSimple: String,
    val juzNumber: Int,
    val hizbNumber: Int,
    val rubNumber: Int,
    val pageNumber: Int,
    val sajdaType: SajdaType?,
    val sajdaNumber: Int?,
    val translation: String? = null,
    val isBookmarked: Boolean = false,
    val transliteration: String? = null,
    val textTajweed: String? = null
)

Int

Unique identifier for the ayah

textArabic

String

Arabic text of the verse

sajdaType

SajdaType?

Indicates if this verse requires prostration (obligatory or recommended)

QuranBookmark

Stores user bookmarks for specific ayahs.

data class QuranBookmark(
    val id: Long,
    val ayahId: Int,
    val surahNumber: Int,
    val ayahNumber: Int,
    val surahName: String? = null,
    val ayahText: String? = null,
    val note: String?,
    val color: String?,
    val createdAt: Long,
    val updatedAt: Long
)

ReadingProgress

Tracks user’s Quran reading progress.

data class ReadingProgress(
    val lastReadSurah: Int,
    val lastReadAyah: Int,
    val lastReadPage: Int,
    val lastReadJuz: Int,
    val totalAyahsRead: Int,
    val currentKhatmaCount: Int,
    val updatedAt: Long
)

RevelationType

Enumeration for where a surah was revealed.

enum class RevelationType {
    MECCAN,
    MEDINAN
}

SajdaType

Enumeration for prostration types in the Quran.

enum class SajdaType {
    OBLIGATORY,
    RECOMMENDED
}

Prayer models

Models for prayer times, tracking, and statistics.

PrayerTimes

Calculated prayer times for a specific date and location.

data class PrayerTimes(
    val fajr: LocalDateTime,
    val sunrise: LocalDateTime,
    val dhuhr: LocalDateTime,
    val asr: LocalDateTime,
    val maghrib: LocalDateTime,
    val isha: LocalDateTime,
    val date: LocalDate,
    val location: Location
)

PrayerRecord

Records whether a prayer was prayed, missed, or marked as qada.

data class PrayerRecord(
    val id: Long,
    val date: Long,
    val prayerName: PrayerName,
    val status: PrayerStatus,
    val prayedAt: Long?,
    val scheduledTime: Long,
    val isJamaah: Boolean,
    val isQadaFor: Long?,
    val note: String?,
    val createdAt: Long,
    val updatedAt: Long
)

prayerName

PrayerName

The name of the prayer (Fajr, Dhuhr, Asr, Maghrib, Isha)

status

PrayerStatus

Current status: PRAYED, MISSED, QADA, PENDING, LATE, or NOT_PRAYED

isJamaah

Boolean

Whether the prayer was performed in congregation

PrayerName

enum class PrayerName {
    FAJR,
    SUNRISE,
    DHUHR,
    ASR,
    MAGHRIB,
    ISHA
}

PrayerStatus

enum class PrayerStatus {
    PRAYED,
    MISSED,
    QADA,
    PENDING,
    LATE,
    NOT_PRAYED
}

Location

Stores location data with prayer calculation settings.

data class Location(
    val id: Long,
    val name: String,
    val latitude: Double,
    val longitude: Double,
    val timezone: String,
    val country: String?,
    val city: String?,
    val isCurrentLocation: Boolean,
    val isFavorite: Boolean,
    val calculationMethod: CalculationMethod,
    val asrCalculation: AsrCalculation,
    val highLatitudeRule: HighLatitudeRule?,
    val fajrAngle: Double?,
    val ishaAngle: Double?
)

CalculationMethod

Different methods for calculating prayer times.

enum class CalculationMethod {
    MUSLIM_WORLD_LEAGUE,
    EGYPTIAN,
    KARACHI,
    UMM_AL_QURA,
    DUBAI,
    MOON_SIGHTING_COMMITTEE,
    NORTH_AMERICA,
    KUWAIT,
    QATAR,
    SINGAPORE,
    TURKEY
}

PrayerStats

Statistics about prayer tracking over a time period.

data class PrayerStats(
    val totalPrayed: Int,
    val totalMissed: Int,
    val totalJamaah: Int,
    val prayedByPrayer: Map<PrayerName, Int>,
    val missedByPrayer: Map<PrayerName, Int>,
    val currentStreak: Int,
    val longestStreak: Int,
    val perfectDays: Int,
    val startDate: Long,
    val endDate: Long
)

Hadith models

Models for hadith collections, books, and chapters.

HadithBook

Represents a hadith collection (e.g., Sahih Bukhari, Sahih Muslim).

data class HadithBook(
    val id: String,
    val nameArabic: String,
    val nameEnglish: String,
    val authorName: String,
    val authorArabic: String,
    val totalHadiths: Int,
    val totalChapters: Int,
    val description: String?,
    val displayOrder: Int
)

HadithChapter

Represents a chapter within a hadith book.

data class HadithChapter(
    val id: String,
    val bookId: String,
    val chapterNumber: Int,
    val nameArabic: String,
    val nameEnglish: String,
    val hadithCount: Int,
    val hadithStartNumber: Int,
    val hadithEndNumber: Int
)

Hadith

Represents an individual hadith narration.

data class Hadith(
    val id: String,
    val bookId: String,
    val chapterId: String,
    val hadithNumber: Int,
    val hadithNumberInBook: Int,
    val textArabic: String,
    val textEnglish: String,
    val narratorChain: String?,
    val narratorName: String?,
    val grade: HadithGrade?,
    val gradeArabic: String?,
    val reference: String?,
    val isBookmarked: Boolean = false
)

HadithGrade

Authenticity grading for hadiths.

enum class HadithGrade {
    SAHIH,      // Authentic
    HASAN,      // Good
    DAIF,       // Weak
    MAWDU,      // Fabricated
    UNKNOWN
}

Dua models

Models for supplications and their categories.

DuaCategory

Categories for organizing duas.

data class DuaCategory(
    val id: String,
    val nameArabic: String,
    val nameEnglish: String,
    val description: String?,
    val iconName: String?,
    val displayOrder: Int,
    val duaCount: Int
)

Dua

Represents a supplication with Arabic text, transliteration, and translation.

data class Dua(
    val id: String,
    val categoryId: String,
    val titleArabic: String,
    val titleEnglish: String,
    val textArabic: String,
    val textTransliteration: String?,
    val textEnglish: String,
    val reference: String?,
    val occasion: DuaOccasion?,
    val benefits: String?,
    val repeatCount: Int?,
    val audioUrl: String?,
    val displayOrder: Int,
    val isFavorite: Boolean = false,
    val isBookmarked: Boolean = false
)

DuaOccasion

Times or situations when a dua is recommended.

enum class DuaOccasion {
    MORNING,
    EVENING,
    AFTER_PRAYER,
    BEFORE_SLEEP,
    WAKING_UP,
    EATING,
    TRAVELING,
    ENTERING_MOSQUE,
    LEAVING_MOSQUE,
    ENTERING_HOME,
    LEAVING_HOME,
    RAIN,
    DISTRESS,
    FORGIVENESS,
    PARENTS,
    GRATITUDE,
    GENERAL
}

Tasbih models

Models for digital tasbih (dhikr counter).

TasbihPreset

Predefined dhikr phrases with target counts.

data class TasbihPreset(
    val id: Long,
    val name: String,
    val arabicText: String?,
    val transliteration: String?,
    val translation: String?,
    val targetCount: Int,
    val category: TasbihCategory?,
    val reference: String?,
    val isDefault: Boolean,
    val displayOrder: Int,
    val createdAt: Long,
    val updatedAt: Long
)

TasbihSession

Tracks a tasbih counting session.

data class TasbihSession(
    val id: Long,
    val presetId: Long?,
    val presetName: String?,
    val date: Long,
    val currentCount: Int,
    val targetCount: Int,
    val totalLaps: Int,
    val isCompleted: Boolean,
    val duration: Long?,
    val startedAt: Long,
    val completedAt: Long?,
    val note: String?
)

TasbihCategory

enum class TasbihCategory {
    DAILY,
    AFTER_PRAYER,
    MORNING,
    EVENING,
    CUSTOM
}

Fasting models

Models for Ramadan and voluntary fasting tracking.

FastRecord

Records fasting for a specific day.

data class FastRecord(
    val id: Long,
    val date: Long,
    val hijriDate: String?,
    val hijriMonth: Int?,
    val hijriYear: Int?,
    val fastType: FastType,
    val status: FastStatus,
    val exemptionReason: ExemptionReason?,
    val suhoorTime: Long?,
    val iftarTime: Long?,
    val note: String?,
    val createdAt: Long,
    val updatedAt: Long
)

FastType

enum class FastType {
    RAMADAN,
    VOLUNTARY,
    MAKEUP,
    EXPIATION,
    VOW
}

FastStatus

enum class FastStatus {
    FASTED,
    NOT_FASTED,
    EXEMPTED,
    MAKEUP_DUE
}

MakeupFast

Tracks makeup fasts that need to be completed.

data class MakeupFast(
    val id: Long,
    val originalDate: Long,
    val originalHijriDate: String?,
    val reason: String,
    val status: MakeupFastStatus,
    val completedDate: Long?,
    val fidyaAmount: Double?,
    val note: String?,
    val createdAt: Long,
    val updatedAt: Long
)

Zakat models

Models for zakat calculation.

ZakatCalculation

Complete zakat calculation result.

data class ZakatCalculation(
    val id: Long = 0,
    val calculatedAt: Long = System.currentTimeMillis(),
    val totalAssets: Double,
    val totalLiabilities: Double,
    val netWorth: Double,
    val nisabType: NisabType,
    val nisabValue: Double,
    val isAboveNisab: Boolean,
    val zakatableAmount: Double = netWorth,
    val zakatDue: Double,
    val goldValue: Double = 0.0,
    val silverValue: Double = 0.0,
    val currency: String = "USD",
    val note: String? = null
)

ZakatAssets

All assets to be considered for zakat.

data class ZakatAssets(
    val cashOnHand: Double = 0.0,
    val bankBalance: Double = 0.0,
    val goldGrams: Double = 0.0,
    val silverGrams: Double = 0.0,
    val investments: Double = 0.0,
    val businessInventory: Double = 0.0,
    val receivables: Double = 0.0,
    val rentalIncome: Double = 0.0,
    val otherAssets: Double = 0.0
)

NisabType

Threshold calculation based on gold or silver.

enum class NisabType {
    GOLD,    // 87.48 grams
    SILVER   // 612.36 grams
}

Khatam models

Models for Quran completion tracking.

Khatam

Represents a Quran reading plan/goal.

data class Khatam(
    val id: Long = 0,
    val name: String,
    val notes: String? = null,
    val status: KhatamStatus = KhatamStatus.ACTIVE,
    val isActive: Boolean = false,
    val dailyTarget: Int = 20,
    val deadline: Long? = null,
    val reminderEnabled: Boolean = false,
    val reminderTime: String? = null,
    val totalAyahsRead: Int = 0,
    val createdAt: Long = System.currentTimeMillis(),
    val startedAt: Long? = null,
    val completedAt: Long? = null,
    val updatedAt: Long = System.currentTimeMillis()
)

dailyTarget

Int

Number of ayahs to read per day

totalAyahsRead

Int

Progress out of 6,236 total Quran ayahs

KhatamStatus

enum class KhatamStatus {
    ACTIVE,
    COMPLETED,
    ABANDONED
}

JuzProgressInfo

Progress for a specific juz in a khatam.

data class JuzProgressInfo(
    val juzNumber: Int,
    val totalAyahs: Int,
    val readAyahs: Int
)

Qibla models

Models for Qibla direction calculation.

QiblaDirection

Calculated direction to the Kaaba.

data class QiblaDirection(
    val bearing: Double,      // Degrees from North (0-360)
    val distance: Double,     // Distance to Kaaba in kilometers
    val userLatitude: Double,
    val userLongitude: Double
)

CompassData

Device compass sensor data.

data class CompassData(
    val azimuth: Float = 0f,       // Device heading in degrees (0-360)
    val pitch: Float = 0f,         // Device tilt forward/backward
    val roll: Float = 0f,          // Device tilt left/right
    val accuracy: CompassAccuracy = CompassAccuracy.MEDIUM,
    val timestamp: Long = System.currentTimeMillis()
)

CompassAccuracy

enum class CompassAccuracy {
    UNRELIABLE,
    LOW,
    MEDIUM,
    HIGH
}

Asma ul Husna models

Models for the 99 names of Allah.

AsmaUlHusna

Represents one of the 99 beautiful names of Allah.

data class AsmaUlHusna(
    val id: Int,
    val number: Int,
    val nameArabic: String,
    val nameTransliteration: String,
    val nameEnglish: String,
    val meaning: String,
    val explanation: String,
    val benefits: String,
    val quranReferences: List<String>,
    val usageInDua: String,
    val displayOrder: Int,
    val isFavorite: Boolean = false
)

Architecture

Domain Layer

Data Layer

UI Layer

Contributing

​Quran models

​Surah

​Ayah

​QuranBookmark

​ReadingProgress

​RevelationType

​SajdaType

​Prayer models

​PrayerTimes

​PrayerRecord

​PrayerName

​PrayerStatus

​Location

​CalculationMethod

​PrayerStats

​Hadith models

​HadithBook

​HadithChapter

​Hadith

​HadithGrade

​Dua models

​DuaCategory

​Dua

​DuaOccasion

​Tasbih models

​TasbihPreset

​TasbihSession

​TasbihCategory

​Fasting models

​FastRecord

​FastType

​FastStatus

​MakeupFast

​Zakat models

​ZakatCalculation

​ZakatAssets

​NisabType

​Khatam models

​Khatam

​KhatamStatus

​JuzProgressInfo

​Qibla models

​QiblaDirection

​CompassData

​CompassAccuracy

​Asma ul Husna models

​AsmaUlHusna

Build docs developers (and LLMs) love

Quran models

Surah

Ayah

QuranBookmark

ReadingProgress

RevelationType

SajdaType

Prayer models

PrayerTimes

PrayerRecord

PrayerName

PrayerStatus

Location

CalculationMethod

PrayerStats

Hadith models

HadithBook

HadithChapter

Hadith

HadithGrade

Dua models

DuaCategory

Dua

DuaOccasion

Tasbih models

TasbihPreset

TasbihSession

TasbihCategory

Fasting models

FastRecord

FastType

FastStatus

MakeupFast

Zakat models

ZakatCalculation

ZakatAssets

NisabType

Khatam models

Khatam

KhatamStatus

JuzProgressInfo

Qibla models

QiblaDirection

CompassData

CompassAccuracy

Asma ul Husna models

AsmaUlHusna