Documentation for features/loan-account

Author: WizCoderr

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/component/AccountSummaryCard.kt

@@ -52,6 +52,15 @@ import org.mifos.mobile.core.designsystem.theme.MifosTypography
 import kotlin.collections.component1
 import kotlin.collections.component2
 
+/**
+ * A composable that displays a summary of account details in a card format.
+ * The card is expandable to show more details.
+ *
+ * @param keyValuePairs A map of key-value pairs to display as account details. The key is a
+ *   [StringResource] for the label, and the value is the string to display.
+ * @param modifier The modifier to be applied to the component.
+ * @param title The title of the card.
+ */
 @Composable
 fun AccountSummaryCard(
     keyValuePairs: Map<StringResource, String?>,

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/component/LoanActionItems.kt

@@ -29,47 +29,74 @@ import org.jetbrains.compose.resources.StringResource
 import org.mifos.mobile.core.common.Constants
 import org.mifos.mobile.core.designsystem.icon.MifosIcons
 
+/**
+ * Represents the different actions that can be performed on a loan account.
+ * Each action has a title, subtitle, icon, and a route for navigation.
+ *
+ * @property title The title of the action item.
+ * @property subTitle A brief description of the action.
+ * @property icon The icon representing the action.
+ * @property route The navigation route associated with the action.
+ */
 sealed class LoanActionItems(
     val title: StringResource,
     val subTitle: StringResource,
     val icon: ImageVector,
     val route: String,
 ) {
+    /**
+     * Action to make a payment on the loan account.
+     */
     data object MakePayment : LoanActionItems(
         title = Res.string.feature_account_action_make_payment,
         subTitle = Res.string.feature_account_action_make_payment_tip,
         icon = MifosIcons.Money,
         route = Constants.MAKE_PAYMENT,
     )
 
+    /**
+     * Action to view the loan summary.
+     */
     data object LoanSummary : LoanActionItems(
         title = Res.string.feature_account_action_loan_summary,
         subTitle = Res.string.feature_account_action_loan_summary_tip,
         icon = MifosIcons.MoneyHand,
         route = Constants.LOAN_SUMMARY,
     )
 
+    /**
+     * Action to view the repayment schedule of the loan.
+     */
     data object RepaymentSchedule : LoanActionItems(
         title = Res.string.feature_account_action_repayment_schedule,
         subTitle = Res.string.feature_account_action_repayment_schedule_tip,
         icon = MifosIcons.MoneyHand,
         route = Constants.REPAYMENT_SCHEDULE,
     )
 
+    /**
+     * Action to view the transaction history of the loan account.
+     */
     data object Transactions : LoanActionItems(
         title = Res.string.feature_account_action_transactions,
         subTitle = Res.string.feature_account_action_transactions_tip,
         icon = MifosIcons.ChatHistory,
         route = Constants.TRANSACTIONS,
     )
 
+    /**
+     * Action to view the charges associated with the loan account.
+     */
     data object Charges : LoanActionItems(
         title = Res.string.feature_account_action_charges,
         subTitle = Res.string.feature_account_action_charges_tip,
         icon = MifosIcons.ReceiptMoney,
         route = Constants.CHARGES,
     )
 
+    /**
+     * Action to generate a QR code for the loan account.
+     */
     data object QrCode : LoanActionItems(
         title = Res.string.feature_account_action_qr,
         subTitle = Res.string.feature_account_action_qr_tip,
@@ -78,6 +105,9 @@ sealed class LoanActionItems(
     )
 }
 
+/**
+ * A list of all available loan account actions.
+ */
 internal val loanAccountActions: ImmutableList<LoanActionItems> = persistentListOf(
     LoanActionItems.MakePayment,
     LoanActionItems.LoanSummary,

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/component/RepaymentPeriodCard.kt

@@ -49,6 +49,17 @@ import org.mifos.mobile.core.model.entity.accounts.loan.Periods
 import kotlin.time.Clock
 import kotlin.time.ExperimentalTime
 
+/**
+ * A composable that displays a single item in a repayment schedule.
+ * It shows details such as the installment number, due date, and amount.
+ * It also provides a button to pay the installment if it's due.
+ *
+ * @param period The [Periods] object containing the details of the repayment period.
+ * @param currencyCode The currency code to use for formatting the amount.
+ * @param maxDigits The maximum number of digits to display for the fractional part of the amount.
+ * @param modifier The modifier to be applied to the component.
+ * @param onPayClick A callback that is invoked when the pay button is clicked.
+ */
 @OptIn(ExperimentalTime::class)
 @Composable
 fun RepaymentScheduleItem(

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/loanAccount/LoanAccountNavigation.kt

@@ -17,12 +17,25 @@ import androidx.navigation.NavOptions
 import kotlinx.serialization.Serializable
 import org.mifos.mobile.core.ui.composableWithSlideTransitions
 
+/**
+ * A route for the loan account screen.
+ */
 @Serializable
 data object LoanAccountRoute
 
+/**
+ * Navigates to the loan account screen.
+ *
+ * @param navOptions The navigation options.
+ */
 fun NavController.navigateToLoanAccountScreen(navOptions: NavOptions? = null) =
     navigate(LoanAccountRoute, navOptions)
 
+/**
+ * Defines the loan account screen destination in the navigation graph.
+ *
+ * @param navigateBack A callback to navigate back to the previous screen.
+ */
 fun NavGraphBuilder.loanAccountDestination(
     navigateBack: () -> Unit,
 ) {

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/loanAccount/LoanAccountScreen.kt

@@ -61,6 +61,19 @@ import org.mifos.mobile.core.ui.utils.EventsEffect
 import org.mifos.mobile.core.ui.utils.ScreenUiState
 import kotlin.collections.orEmpty
 
+/**
+ * The main composable for the loan account screen.
+ * It displays a list of loan accounts and allows the user to filter them.
+ *
+ * @param navigateBack A callback to navigate back to the previous screen.
+ * @param onAccountClicked A callback that is invoked when a loan account is clicked.
+ * @param refreshSignal A signal to trigger a refresh of the account list.
+ * @param onLoadingCompleted A callback that is invoked when the initial loading is completed.
+ * @param accountTypeFilters A list of account type filters to apply.
+ * @param accountStatusFilters A list of account status filters to apply.
+ * @param filtersClicked A callback that is invoked when the filter button is clicked.
+ * @param viewModel The [LoanAccountsViewmodel] for this screen.
+ */
 @Composable
 fun LoanAccountScreen(
     navigateBack: () -> Unit,
@@ -117,6 +130,13 @@ fun LoanAccountScreen(
     )
 }
 
+/**
+ * A composable that displays a dialog for the loan account screen.
+ * It can show an error dialog.
+ *
+ * @param dialogState The state of the dialog to display.
+ * @param onAction A callback to handle actions from the dialog.
+ */
 @Composable
 internal fun LoanAccountDialog(
     dialogState: LoanAccountsState.DialogState?,
@@ -135,6 +155,15 @@ internal fun LoanAccountDialog(
     }
 }
 
+/**
+ * The content of the loan account screen.
+ * It displays a dashboard card with the total loan amount and a list of loan accounts.
+ * It also handles different UI states such as loading, error, network, and empty.
+ *
+ * @param state The [LoanAccountsState] for this screen.
+ * @param onAction A callback to handle actions from the screen.
+ * @param filtersClicked A callback that is invoked when the filter button is clicked.
+ */
 @Composable
 internal fun LoanAccountContent(
     state: LoanAccountsState,

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/loanAccount/LoanAccountViewModel.kt

@@ -31,12 +31,12 @@ import org.mifos.mobile.feature.loanaccount.utils.FilterUtil
 import kotlin.collections.firstOrNull
 
 /**
- * ViewModel responsible for managing loan account UI state, fetching, filtering,
- * and reacting to user actions and network changes.
+ * ViewModel for the loan accounts screen.
+ * It is responsible for fetching and filtering loan accounts, and for handling user actions.
  *
- * @param accountsRepositoryImpl Provides access to account data.
- * @param networkMonitor Observes network connectivity.
- * @param userPreferencesRepositoryImpl Provides user-specific data such as client ID.
+ * @param accountsRepositoryImpl The repository for fetching account data.
+ * @param networkMonitor The network monitor to observe network connectivity.
+ * @param userPreferencesRepositoryImpl The repository for user preferences.
  */
 class LoanAccountsViewmodel(
     private val accountsRepositoryImpl: AccountsRepository,
@@ -307,8 +307,22 @@ class LoanAccountsViewmodel(
 }
 
 /**
- * State holder for the Loan Account screen.
- * Contains all values needed to render the UI and manage logic.
+ * Represents the state of the loan accounts screen.
+ *
+ * @property loanAccounts The list of loan accounts to display.
+ * @property originalAccounts The original, unfiltered list of loan accounts.
+ * @property isFilteredEmpty Whether the filtered list of accounts is empty.
+ * @property firstLaunch Whether this is the first time the screen is launched.
+ * @property items The number of filtered accounts.
+ * @property totalLoanAmount The total loan amount computed from the accounts.
+ * @property currency The currency symbol (e.g., ₹, $, etc.).
+ * @property decimals The number of decimals to display for the amount.
+ * @property clientId The current client ID from user preferences.
+ * @property dialogState The currently active dialog (Error).
+ * @property selectedFilters The filters currently applied.
+ * @property isAmountVisible Whether the account balances are visible.
+ * @property networkStatus The network connectivity status.
+ * @property uiState The overall state of the screen.
  */
 data class LoanAccountsState(
     val loanAccounts: List<LoanAccount>?,
@@ -353,48 +367,83 @@ data class LoanAccountsState(
      * Sealed class representing possible dialog states.
      */
     sealed interface DialogState {
+        /**
+         * An error dialog with a message.
+         *
+         * @param message The error message to display.
+         */
         data class Error(val message: String) : DialogState
     }
 }
 
 /**
- * Represents user or system actions for the Loan Account screen.
+ * Represents the actions that can be taken on the loan accounts screen.
  */
 sealed interface LoanAccountsAction {
 
+    /**
+     * Action to indicate that the screen is being launched for the first time.
+     */
     data object OnFirstLaunched : LoanAccountsAction
 
-    /** Dismiss any open dialog */
+    /**
+     * Action to dismiss any open dialog.
+     */
     data object OnDismissDialog : LoanAccountsAction
 
-    /** Navigate back from the screen */
+    /**
+     * Action to navigate back from the screen.
+     */
     data object OnNavigateBack : LoanAccountsAction
 
-    /** Toggle visibility of loan amount */
+    /**
+     * Action to toggle the visibility of the loan amount.
+     */
     data object ToggleAmountVisible : LoanAccountsAction
 
+    /**
+     * Action to retry a failed operation.
+     */
     data object OnRetry : LoanAccountsAction
 
-    /** Load loan accounts with applied filters */
+    /**
+     * Action to load the loan accounts with the given filters.
+     *
+     * @param filters The filters to apply.
+     */
     data class LoadAccounts(
         val filters: List<StringResource?>,
     ) : LoanAccountsAction
 
-    /** Navigate to a selected account's detail page */
+    /**
+     * Action to handle a click on a loan account.
+     *
+     * @param accountId The ID of the clicked account.
+     * @param accountType The type of the clicked account.
+     */
     data class OnAccountClicked(
         val accountId: Long,
         val accountType: String,
     ) : LoanAccountsAction
 
-    /** Action to observe network status */
+    /**
+     * Action to receive the network status.
+     *
+     * @param isOnline Whether the device is online.
+     */
     data class ReceiveNetworkStatus(val isOnline: Boolean) : LoanAccountsAction
 
     /**
      * Internal-only actions triggered by repository/data flow.
      */
     sealed interface Internal : LoanAccountsAction {
 
-        /** Called when account data is received from repository */
+        /**
+         * Action to receive the loan accounts from the repository.
+         *
+         * @param filters The filters that were applied.
+         * @param dataState The result of the data fetch.
+         */
         data class ReceiveLoanAccounts(
             val filters: List<StringResource?>,
             val dataState: DataState<ClientAccounts>,
@@ -403,19 +452,28 @@ sealed interface LoanAccountsAction {
 }
 
 /**
- * One-time UI events for the Loan Account screen.
+ * Represents the one-time events that can be sent from the ViewModel to the UI.
  */
 sealed interface LoanAccountsEvent {
 
-    /** Trigger navigation to selected account's detail screen */
+    /**
+     * Event to trigger navigation to the selected account's detail screen.
+     *
+     * @param accountId The ID of the clicked account.
+     * @param accountType The type of the clicked account.
+     */
     data class AccountClicked(
         val accountId: Long,
         val accountType: String,
     ) : LoanAccountsEvent
 
-    /** Signals the UI that loading is complete */
+    /**
+     * Event to signal that the loading is complete.
+     */
     data object LoadingCompleted : LoanAccountsEvent
 
-    /** Navigates back to the previous screen */
+    /**
+     * Event to navigate back to the previous screen.
+     */
     data object NavigateBack : LoanAccountsEvent
 }

feature/loan-account/src/commonMain/kotlin/org/mifos/mobile/feature/loanaccount/loanAccountDetails/LoanAccountDetailsNavigation.kt

@@ -18,14 +18,36 @@ import kotlinx.serialization.Serializable
 import org.mifos.mobile.core.model.entity.AccountDetails
 import org.mifos.mobile.core.ui.composableWithSlideTransitions
 
+/**
+ * A route for the loan account details screen.
+ *
+ * @property accountId The ID of the loan account.
+ */
 @Serializable
 data class LoanAccountDetailsRoute(
     val accountId: Long,
 )
 
+/**
+ * Navigates to the loan account details screen.
+ *
+ * @param accountId The ID of the loan account.
+ * @param navOptions The navigation options.
+ */
 fun NavController.navigateToLoanAccountDetailsScreen(accountId: Long, navOptions: NavOptions? = null) =
     navigate(LoanAccountDetailsRoute(accountId), navOptions)
 
+/**
+ * Defines the loan account details screen destination in the navigation graph.
+ *
+ * @param navigateBack A callback to navigate back to the previous screen.
+ * @param navigateToMakePaymentScreen A callback to navigate to the make payment screen.
+ * @param navigateToRepaymentScheduleScreen A callback to navigate to the repayment schedule screen.
+ * @param navigateToLoanSummaryScreen A callback to navigate to the loan summary screen.
+ * @param navigateToQrCodeScreen A callback to navigate to the QR code screen.
+ * @param navigateToClientChargeScreen A callback to navigate to the client charge screen.
+ * @param navigateToLoanAccountTransactionScreen A callback to navigate to the loan account transaction screen.
+ */
 fun NavGraphBuilder.loanAccountDetailsDestination(
     navigateBack: () -> Unit,
     navigateToMakePaymentScreen: (AccountDetails) -> Unit,