Skip to content

A local-first personal finance app

Add target income adjustment factor to crossover report (#6373)

Jonathon Jongsma31349b7bc8ed
diff --git a/packages/desktop-client/src/components/reports/graphs/CrossoverGraph.tsx b/packages/desktop-client/src/components/reports/graphs/CrossoverGraph.tsx
index 1d507dcaa0..b74d198c1f 100644
--- a/packages/desktop-client/src/components/reports/graphs/CrossoverGraph.tsx
+++ b/packages/desktop-client/src/components/reports/graphs/CrossoverGraph.tsx
@@ -28,6 +28,7 @@ type CrossoverGraphProps = {
investmentIncome: number;
expenses: number;
nestEgg: number;
+ adjustedExpenses?: number;
isProjection?: boolean;
}>;
start: string;
@@ -62,6 +63,7 @@ export function CrossoverGraph({
investmentIncome: number | string;
expenses: number | string;
nestEgg: number | string;
+ adjustedExpenses?: number | string;
isProjection?: boolean;
};
};
@@ -120,6 +122,21 @@ export function CrossoverGraph({
</div>
<div>{format(payload[0].payload.expenses, 'financial')}</div>
</View>
+ {payload[0].payload.adjustedExpenses != null && (
+ <View
+ className={css({
+ display: 'flex',
+ justifyContent: 'space-between',
+ })}
+ >
+ <div>
+ <Trans>Target income:</Trans>
+ </div>
+ <div>
+ {format(payload[0].payload.adjustedExpenses, 'financial')}
+ </div>
+ </View>
+ )}
<View
className={css({
display: 'flex',
@@ -201,6 +218,15 @@ export function CrossoverGraph({
strokeWidth={2}
{...animationProps}
/>
+ <Line
+ type="monotone"
+ dataKey="adjustedExpenses"
+ dot={false}
+ stroke={theme.reportsRed}
+ strokeWidth={2}
+ strokeDasharray="5 5"
+ {...animationProps}
+ />
</LineChart>
</div>
</ResponsiveContainer>
diff --git a/packages/desktop-client/src/components/reports/reports/Crossover.tsx b/packages/desktop-client/src/components/reports/reports/Crossover.tsx
index 34f761b8a3..d7799f33b2 100644
--- a/packages/desktop-client/src/components/reports/reports/Crossover.tsx
+++ b/packages/desktop-client/src/components/reports/reports/Crossover.tsx
@@ -57,6 +57,7 @@ type CrossoverData = {
investmentIncome: number;
expenses: number;
nestEgg: number;
+ adjustedExpenses?: number;
isProjection?: boolean;
}>;
start: string;
@@ -129,6 +130,7 @@ function CrossoverInner({ widget }: CrossoverInnerProps) {
const [projectionType, setProjectionType] = useState<'trend' | 'hampel'>(
'hampel',
);
+ const [expenseAdjustmentFactor, setExpenseAdjustmentFactor] = useState(1.0);
const [showHiddenCategories, setShowHiddenCategories] = useState(false);
const [selectionsInitialized, setSelectionsInitialized] = useState(false);
@@ -162,6 +164,7 @@ function CrossoverInner({ widget }: CrossoverInnerProps) {
setSwr(widget?.meta?.safeWithdrawalRate ?? 0.04);
setEstimatedReturn(widget?.meta?.estimatedReturn ?? null);
setProjectionType(widget?.meta?.projectionType ?? 'hampel');
+ setExpenseAdjustmentFactor(widget?.meta?.expenseAdjustmentFactor ?? 1.0);
setShowHiddenCategories(widget?.meta?.showHiddenCategories ?? false);
setSelectionsInitialized(true);
@@ -291,6 +294,7 @@ function CrossoverInner({ widget }: CrossoverInnerProps) {
safeWithdrawalRate: swr,
estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
showHiddenCategories,
timeFrame: { start, end, mode },
},
@@ -332,6 +336,7 @@ function CrossoverInner({ widget }: CrossoverInnerProps) {
safeWithdrawalRate: swr,
estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
});
await crossoverSpreadsheet(spreadsheet, setData);
},
@@ -341,6 +346,7 @@ function CrossoverInner({ widget }: CrossoverInnerProps) {
swr,
estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
expenseCategoryIds,
selectedIncomeAccountIds,
],
@@ -724,6 +730,72 @@ function CrossoverInner({ widget }: CrossoverInnerProps) {
/>
</View>
+ <View style={{ marginBottom: 12 }}>
+ <div style={{ fontWeight: 600, marginBottom: 8 }}>
+ <View
+ style={{
+ flexDirection: 'row',
+ alignItems: 'center',
+ justifyContent: 'space-between',
+ }}
+ >
+ <Text>{t('Target Income (% of expenses)')}</Text>
+ <Tooltip
+ content={
+ <View style={{ maxWidth: 300 }}>
+ <Text>
+ <Trans>
+ Your target retirement income as a percentage of
+ projected expenses.
+ <br />
+ <br />
+ 100% means you need retirement income equal to
+ your current projected expenses.
+ <br />
+ Values above 100% mean you plan to spend more in
+ retirement.
+ <br />
+ Values below 100% mean you plan to spend less in
+ retirement.
+ <br />
+ <br />
+ The graph shows both the projected expenses (solid
+ red line) and your target income (dashed red
+ line).
+ </Trans>
+ </Text>
+ </View>
+ }
+ placement="right top"
+ style={{
+ ...styles.tooltip,
+ }}
+ >
+ <SvgQuestion height={12} width={12} cursor="pointer" />
+ </Tooltip>
+ </View>
+ </div>
+ <Input
+ type="number"
+ min={0}
+ max={1000}
+ step={1}
+ value={
+ expenseAdjustmentFactor == null
+ ? ''
+ : Number((expenseAdjustmentFactor * 100).toFixed(0))
+ }
+ onChange={e =>
+ setExpenseAdjustmentFactor(
+ isNaN(e.target.valueAsNumber)
+ ? 1.0
+ : e.target.valueAsNumber / 100,
+ )
+ }
+ style={{ width: 120, marginBottom: 12 }}
+ />
+ </View>
+
<View style={{ marginBottom: 12 }}>
<div style={{ fontWeight: 600, marginBottom: 8 }}>
<View
diff --git a/packages/desktop-client/src/components/reports/reports/CrossoverCard.tsx b/packages/desktop-client/src/components/reports/reports/CrossoverCard.tsx
index 0e5724d9dc..91979dadf4 100644
--- a/packages/desktop-client/src/components/reports/reports/CrossoverCard.tsx
+++ b/packages/desktop-client/src/components/reports/reports/CrossoverCard.tsx
@@ -32,6 +32,7 @@ type CrossoverData = {
investmentIncome: number;
expenses: number;
nestEgg: number;
+ adjustedExpenses?: number;
isProjection?: boolean;
}>;
start: string;
@@ -165,6 +166,7 @@ export function CrossoverCard({
const swr = meta?.safeWithdrawalRate ?? 0.04;
const estimatedReturn = meta?.estimatedReturn ?? null;
const projectionType = meta?.projectionType ?? 'hampel';
+ const expenseAdjustmentFactor = meta?.expenseAdjustmentFactor ?? 1.0;
const params = useMemo(
() =>
@@ -176,6 +178,7 @@ export function CrossoverCard({
safeWithdrawalRate: swr,
estimatedReturn: estimatedReturn == null ? null : estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
}),
[
start,
@@ -185,6 +188,7 @@ export function CrossoverCard({
swr,
estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
],
);
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/crossover-spreadsheet.ts b/packages/desktop-client/src/components/reports/spreadsheets/crossover-spreadsheet.ts
index 702e3c0077..3c6bccf69a 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/crossover-spreadsheet.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/crossover-spreadsheet.ts
@@ -51,6 +51,7 @@ export type CrossoverParams = {
safeWithdrawalRate: number; // annual percent, e.g. 0.04 for 4%
estimatedReturn?: number | null; // optional annual return to project future balances
projectionType: 'trend' | 'hampel'; // expense projection method
+ expenseAdjustmentFactor?: number; // multiplier for expenses (default 1.0)
};
export function createCrossoverSpreadsheet({
@@ -61,6 +62,7 @@ export function createCrossoverSpreadsheet({
safeWithdrawalRate,
estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
}: CrossoverParams) {
return async (
_spreadsheet: ReturnType<typeof useSpreadsheet>,
@@ -168,6 +170,7 @@ export function createCrossoverSpreadsheet({
safeWithdrawalRate,
estimatedReturn,
projectionType,
+ expenseAdjustmentFactor,
},
expenses,
historicalBalances,
@@ -186,6 +189,7 @@ function recalculate(
| 'safeWithdrawalRate'
| 'estimatedReturn'
| 'projectionType'
+ | 'expenseAdjustmentFactor'
>,
expenses: MonthlyAgg[],
historicalAccounts: Array<{
@@ -233,12 +237,15 @@ function recalculate(
investmentIncome: number;
expenses: number;
nestEgg: number;
+ adjustedExpenses?: number;
isProjection?: boolean;
}> = [];
let lastBalance = 0;
let lastExpense = 0;
let crossoverIndex: number | null = null;
+ const adjustmentFactor = params.expenseAdjustmentFactor ?? 1.0;
+
months.forEach((month, idx) => {
const balance = historicalBalances[idx]; // Use historical balances for data generation
const monthlyIncome = balance * monthlySWR;
@@ -352,17 +359,22 @@ function recalculate(
projectedExpenses = Math.max(0, hampelFilteredExpense);
}
+ // Calculate adjusted expenses
+ const adjustedProjectedExpenses = projectedExpenses * adjustmentFactor;
+
data.push({
x: d.format(monthCursor, 'MMM yyyy'),
investmentIncome: Math.round(projectedIncome),
expenses: Math.round(projectedExpenses),
nestEgg: Math.round(projectedBalance),
+ adjustedExpenses: Math.round(adjustedProjectedExpenses),
isProjection: true,
});
+ // Check crossover against ADJUSTED expenses
if (
crossoverIndex == null &&
- Math.round(projectedIncome) >= Math.round(projectedExpenses)
+ Math.round(projectedIncome) >= Math.round(adjustedProjectedExpenses)
) {
crossoverIndex = months.length + (i - 1);
break;
@@ -381,9 +393,12 @@ function recalculate(
const crossoverDate = d.parse(crossoverData.x, 'MMM yyyy', currentDate);
const monthsDiff = d.differenceInMonths(crossoverDate, currentDate);
yearsToRetire = monthsDiff > 0 ? monthsDiff / 12 : 0;
- targetMonthlyIncome = crossoverData.expenses;
+ targetMonthlyIncome = crossoverData.adjustedExpenses ?? null;
// Calculate target nest egg: target monthly income / monthly safe withdrawal rate
- targetNestEgg = Math.round(targetMonthlyIncome / monthlySWR);
+ targetNestEgg =
+ targetMonthlyIncome != null
+ ? Math.round(targetMonthlyIncome / monthlySWR)
+ : null;
}
}
diff --git a/packages/loot-core/src/types/models/dashboard.ts b/packages/loot-core/src/types/models/dashboard.ts
index a29bc571ab..5beaae9353 100644
--- a/packages/loot-core/src/types/models/dashboard.ts
+++ b/packages/loot-core/src/types/models/dashboard.ts
@@ -75,6 +75,7 @@ export type CrossoverWidget = AbstractWidget<
estimatedReturn?: number | null; // annual
projectionType?: 'trend' | 'hampel'; // expense projection method
showHiddenCategories?: boolean; // show hidden categories in selector
+ expenseAdjustmentFactor?: number; // multiplier for expenses (default 1.0)
} | null
>;
export type MarkdownWidget = AbstractWidget<
diff --git a/upcoming-release-notes/6373.md b/upcoming-release-notes/6373.md
new file mode 100644
index 0000000000..a19b49a3a0
--- /dev/null
+++ b/upcoming-release-notes/6373.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [jonner]
+---
+
+Allow user to adjust target income in crossover report