feat: Beefed up debt log

Author: jmpompeo

CompoundCalc/Models/Requests/DebtStrategyRequest.cs

@@ -0,0 +1,81 @@
+namespace CompoundCalc.Models.Requests;
+
+public sealed class DebtStrategyRequest
+{
+    public DebtStrategyRequest(decimal monthlyBudget, IReadOnlyCollection<DebtStrategyDebtRequest> debts)
+    {
+        MonthlyBudget = monthlyBudget;
+        Debts = debts ?? throw new ArgumentNullException(nameof(debts));
+
+        Validate();
+    }
+
+    public decimal MonthlyBudget { get; }
+
+    public IReadOnlyCollection<DebtStrategyDebtRequest> Debts { get; }
+
+    private void Validate()
+    {
+        if (MonthlyBudget <= 0m)
+        {
+            throw new ArgumentOutOfRangeException(nameof(MonthlyBudget), "Monthly budget must be greater than zero.");
+        }
+
+        if (Debts.Count is < 1 or > 50)
+        {
+            throw new ArgumentOutOfRangeException(nameof(Debts), "Provide between 1 and 50 debts.");
+        }
+    }
+}
+
+public sealed class DebtStrategyDebtRequest
+{
+    public DebtStrategyDebtRequest(
+        string clientDebtId,
+        string name,
+        decimal currentBalance,
+        decimal annualAprPercent,
+        decimal minimumPayment)
+    {
+        if (string.IsNullOrWhiteSpace(clientDebtId))
+        {
+            throw new ArgumentException("Debt id is required.", nameof(clientDebtId));
+        }
+
+        if (string.IsNullOrWhiteSpace(name))
+        {
+            throw new ArgumentException("Debt name is required.", nameof(name));
+        }
+
+        if (currentBalance <= 0m)
+        {
+            throw new ArgumentOutOfRangeException(nameof(currentBalance), "Current balance must be greater than zero.");
+        }
+
+        if (annualAprPercent < 0m || annualAprPercent > 100m)
+        {
+            throw new ArgumentOutOfRangeException(nameof(annualAprPercent), "Annual APR percent must be between 0 and 100.");
+        }
+
+        if (minimumPayment <= 0m)
+        {
+            throw new ArgumentOutOfRangeException(nameof(minimumPayment), "Minimum payment must be greater than zero.");
+        }
+
+        ClientDebtId = clientDebtId.Trim();
+        Name = name.Trim();
+        CurrentBalance = currentBalance;
+        AnnualAprPercent = annualAprPercent;
+        MinimumPayment = minimumPayment;
+    }
+
+    public string ClientDebtId { get; }
+
+    public string Name { get; }
+
+    public decimal CurrentBalance { get; }
+
+    public decimal AnnualAprPercent { get; }
+
+    public decimal MinimumPayment { get; }
+}

CompoundCalc/Models/Responses/DebtStrategyResult.cs

@@ -0,0 +1,47 @@
+namespace CompoundCalc.Models.Responses;
+
+public sealed record DebtStrategyResult(
+    decimal MonthlyBudget,
+    decimal TotalMinimumPayment,
+    string RecommendedStrategy,
+    DebtStrategyPlanResult Snowball,
+    DebtStrategyPlanResult Avalanche,
+    string CalculationVersion);
+
+public sealed record DebtStrategyPlanResult(
+    string Strategy,
+    int MonthsToPayoff,
+    decimal TotalPaid,
+    decimal TotalInterestPaid,
+    string TotalPaidDisplay,
+    string TotalInterestDisplay,
+    string FinalPayoffDateLabel,
+    IReadOnlyList<DebtStrategyPayoffOrderItem> PayoffOrder,
+    IReadOnlyList<DebtStrategyMonthResult> Timeline);
+
+public sealed record DebtStrategyPayoffOrderItem(
+    string ClientDebtId,
+    string Name,
+    int PayoffMonth,
+    decimal StartingBalance,
+    decimal AnnualAprPercent);
+
+public sealed record DebtStrategyMonthResult(
+    int MonthNumber,
+    decimal StartingBalance,
+    decimal InterestCharged,
+    decimal PaymentApplied,
+    decimal EndingBalance,
+    IReadOnlyList<DebtStrategyMonthDebtResult> Debts);
+
+public sealed record DebtStrategyMonthDebtResult(
+    string ClientDebtId,
+    string Name,
+    decimal StartingBalance,
+    decimal InterestCharged,
+    decimal PaymentApplied,
+    decimal MinimumPaymentApplied,
+    decimal ExtraPaymentApplied,
+    decimal EndingBalance,
+    bool IsTargeted,
+    bool IsPaidOffThisMonth);