Skip to content

A local-first personal finance app

Add ability to auto hold funds for future months (#4778)

youngcw47cb5e1ecf5e
diff --git a/packages/desktop-client/src/components/Modals.tsx b/packages/desktop-client/src/components/Modals.tsx
index c5ed8e7c1e..a5b73ec66f 100644
--- a/packages/desktop-client/src/components/Modals.tsx
+++ b/packages/desktop-client/src/components/Modals.tsx
@@ -31,6 +31,7 @@ import { EnvelopeBalanceMenuModal } from './modals/EnvelopeBalanceMenuModal';
import { EnvelopeBudgetMenuModal } from './modals/EnvelopeBudgetMenuModal';
import { EnvelopeBudgetMonthMenuModal } from './modals/EnvelopeBudgetMonthMenuModal';
import { EnvelopeBudgetSummaryModal } from './modals/EnvelopeBudgetSummaryModal';
+import { EnvelopeIncomeBalanceMenuModal } from './modals/EnvelopeIncomeBalanceMenuModal';
import { EnvelopeToBudgetMenuModal } from './modals/EnvelopeToBudgetMenuModal';
import { FixEncryptionKeyModal } from './modals/FixEncryptionKeyModal';
import { GoalTemplateModal } from './modals/GoalTemplateModal';
@@ -274,6 +275,16 @@ export function Modals() {
</NamespaceContext.Provider>
);
+ case 'envelope-income-balance-menu':
+ return (
+ <NamespaceContext.Provider
+ key={key}
+ value={monthUtils.sheetForMonth(modal.options.month)}
+ >
+ <EnvelopeIncomeBalanceMenuModal {...modal.options} />
+ </NamespaceContext.Provider>
+ );
+
case 'envelope-summary-to-budget-menu':
return (
<NamespaceContext.Provider
diff --git a/packages/desktop-client/src/components/budget/envelope/BalanceMenu.tsx b/packages/desktop-client/src/components/budget/envelope/BalanceMenu.tsx
index 1a33b94d67..e80bcaebf4 100644
--- a/packages/desktop-client/src/components/budget/envelope/BalanceMenu.tsx
+++ b/packages/desktop-client/src/components/budget/envelope/BalanceMenu.tsx
@@ -12,9 +12,9 @@ type BalanceMenuProps = Omit<
'onMenuSelect' | 'items'
> & {
categoryId: string;
- onTransfer: () => void;
- onCarryover: (carryOver: boolean) => void;
- onCover: () => void;
+ onTransfer?: () => void;
+ onCarryover?: (carryOver: boolean) => void;
+ onCover?: () => void;
};
export function BalanceMenu({
diff --git a/packages/desktop-client/src/components/budget/envelope/EnvelopeBudgetComponents.tsx b/packages/desktop-client/src/components/budget/envelope/EnvelopeBudgetComponents.tsx
index 246fcc096c..f48da6b865 100644
--- a/packages/desktop-client/src/components/budget/envelope/EnvelopeBudgetComponents.tsx
+++ b/packages/desktop-client/src/components/budget/envelope/EnvelopeBudgetComponents.tsx
@@ -29,6 +29,7 @@ import {
import { BalanceMovementMenu } from './BalanceMovementMenu';
import { BudgetMenu } from './BudgetMenu';
+import { IncomeMenu } from './IncomeMenu';
import { BalanceWithCarryover } from '@desktop-client/components/budget/BalanceWithCarryover';
import { makeAmountGrey } from '@desktop-client/components/budget/util';
@@ -334,7 +335,7 @@ export const ExpenseCategoryMonth = memo(function ExpenseCategoryMonth({
category: category.id,
});
showUndoNotification({
- message: t(`Budget set to last month’s budget.`),
+ message: t(`Budget set to last month‘s budget.`),
});
}}
onSetMonthsAverage={numberOfMonths => {
@@ -482,7 +483,7 @@ export const ExpenseCategoryMonth = memo(function ExpenseCategoryMonth({
}}
onContextMenu={e => {
handleBalanceContextMenu(e);
- // We need to calculate differently from the hook ue to being aligned to the right
+ // We need to calculate differently from the hook due to being aligned to the right
const rect = e.currentTarget.getBoundingClientRect();
resetBalancePosition(
e.clientX - rect.right + 200 - 8,
@@ -553,20 +554,32 @@ type IncomeCategoryMonthProps = {
isLast: boolean;
month: string;
onShowActivity: (id: CategoryEntity['id'], month: string) => void;
+ onBudgetAction: (month: string, action: string, arg?: unknown) => void;
};
export function IncomeCategoryMonth({
category,
isLast,
month,
onShowActivity,
+ onBudgetAction,
}: IncomeCategoryMonthProps) {
+ const incomeMenuTriggerRef = useRef(null);
+ const {
+ setMenuOpen: setIncomeMenuOpen,
+ menuOpen: incomeMenuOpen,
+ handleContextMenu: handleIncomeContextMenu,
+ resetPosition: resetIncomePosition,
+ position: incomePosition,
+ } = useContextMenu();
+
return (
<View style={{ flex: 1 }}>
<Field
name="received"
width="flex"
+ truncate={false}
+ ref={incomeMenuTriggerRef}
style={{
- paddingRight: styles.monthRightPadding,
textAlign: 'right',
...(isLast && { borderBottomWidth: 0 }),
backgroundColor: monthUtils.isCurrentMonth(month)
@@ -574,15 +587,58 @@ export function IncomeCategoryMonth({
: theme.budgetOtherMonth,
}}
>
- <span onClick={() => onShowActivity(category.id, month)}>
- <BalanceWithCarryover
- carryover={envelopeBudget.catCarryover(category.id)}
- balance={envelopeBudget.catSumAmount(category.id)}
- goal={envelopeBudget.catGoal(category.id)}
- budgeted={envelopeBudget.catBudgeted(category.id)}
- longGoal={envelopeBudget.catLongGoal(category.id)}
- />
- </span>
+ <View
+ name="received"
+ style={{
+ display: 'flex',
+ flexDirection: 'row',
+ alignItems: 'center',
+ justifyContent: 'flex-end',
+ position: 'relative',
+ }}
+ >
+ <span
+ onClick={() => {
+ resetIncomePosition(-6, -4);
+ setIncomeMenuOpen(true);
+ }}
+ onContextMenu={e => {
+ handleIncomeContextMenu(e);
+ // We need to calculate differently from the hook due to being aligned to the right
+ const rect = e.currentTarget.getBoundingClientRect();
+ resetIncomePosition(
+ e.clientX - rect.right + 200 - 8,
+ e.clientY - rect.bottom - 8,
+ );
+ }}
+ style={{ paddingRight: styles.monthRightPadding }}
+ >
+ <BalanceWithCarryover
+ carryover={envelopeBudget.catCarryover(category.id)}
+ balance={envelopeBudget.catSumAmount(category.id)}
+ goal={envelopeBudget.catGoal(category.id)}
+ budgeted={envelopeBudget.catBudgeted(category.id)}
+ longGoal={envelopeBudget.catLongGoal(category.id)}
+ />
+ </span>
+ <Popover
+ triggerRef={incomeMenuTriggerRef}
+ placement="bottom end"
+ isOpen={incomeMenuOpen}
+ onOpenChange={() => setIncomeMenuOpen(false)}
+ style={{ margin: 1 }}
+ isNonModal
+ {...incomePosition}
+ >
+ <IncomeMenu
+ categoryId={category.id}
+ month={month}
+ onBudgetAction={onBudgetAction}
+ onShowActivity={onShowActivity}
+ onClose={() => setIncomeMenuOpen(false)}
+ />
+ </Popover>
+ </View>
</Field>
</View>
);
diff --git a/packages/desktop-client/src/components/budget/envelope/IncomeMenu.tsx b/packages/desktop-client/src/components/budget/envelope/IncomeMenu.tsx
new file mode 100644
index 0000000000..b5746e77d3
--- /dev/null
+++ b/packages/desktop-client/src/components/budget/envelope/IncomeMenu.tsx
@@ -0,0 +1,64 @@
+import { useTranslation } from 'react-i18next';
+
+import { Menu } from '@actual-app/components/menu';
+
+import { type CategoryEntity } from 'loot-core/types/models';
+
+import { useEnvelopeSheetValue } from './EnvelopeBudgetComponents';
+
+import { envelopeBudget } from '@desktop-client/queries/queries';
+
+type IncomeMenuProps = {
+ categoryId: string;
+ month: string;
+ onBudgetAction: (month: string, action: string, arg?: unknown) => void;
+ onShowActivity: (id: CategoryEntity['id'], month: string) => void;
+ onClose?: () => void;
+};
+
+export function IncomeMenu({
+ categoryId,
+ month,
+ onBudgetAction,
+ onShowActivity,
+ onClose = () => {},
+}: IncomeMenuProps) {
+ const { t } = useTranslation();
+ const carryover = useEnvelopeSheetValue(
+ envelopeBudget.catCarryover(categoryId),
+ );
+
+ return (
+ <span>
+ <Menu
+ onMenuSelect={name => {
+ switch (name) {
+ case 'view':
+ onShowActivity(categoryId, month);
+ break;
+ case 'carryover':
+ if (!carryover) onBudgetAction(month, 'reset-hold');
+ onBudgetAction(month, 'carryover', {
+ category: categoryId,
+ flag: !carryover,
+ });
+ onClose();
+ break;
+ default:
+ throw new Error(`Unrecognized menu option: ${name}`);
+ }
+ }}
+ items={[
+ {
+ name: 'carryover',
+ text: carryover ? t('Disable auto hold') : t('Enable auto hold'),
+ },
+ {
+ name: 'view',
+ text: t('View transactions'),
+ },
+ ]}
+ />
+ </span>
+ );
+}
diff --git a/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudget.tsx b/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudget.tsx
index 5db4071154..4c6a449e26 100644
--- a/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudget.tsx
+++ b/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudget.tsx
@@ -102,6 +102,8 @@ export function ToBudget({
onBudgetAction(month, 'reset-hold');
setMenuOpen(false);
}}
+ month={month}
+ onBudgetAction={onBudgetAction}
/>
)}
{menuStep === 'buffer' && (
diff --git a/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudgetMenu.tsx b/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudgetMenu.tsx
index 8b83338312..0d81419134 100644
--- a/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudgetMenu.tsx
+++ b/packages/desktop-client/src/components/budget/envelope/budgetsummary/ToBudgetMenu.tsx
@@ -14,18 +14,26 @@ type ToBudgetMenuProps = Omit<
onCover: () => void;
onHoldBuffer: () => void;
onResetHoldBuffer: () => void;
+ onBudgetAction?: (month: string, action: string, arg?: unknown) => void;
+ month: string;
};
+
export function ToBudgetMenu({
onTransfer,
onCover,
onHoldBuffer,
onResetHoldBuffer,
+ onBudgetAction,
+ month,
...props
}: ToBudgetMenuProps) {
const { t } = useTranslation();
const toBudget = useEnvelopeSheetValue(envelopeBudget.toBudget) ?? 0;
const forNextMonth = useEnvelopeSheetValue(envelopeBudget.forNextMonth) ?? 0;
+ const manualBuffered =
+ useEnvelopeSheetValue(envelopeBudget.manualBuffered) ?? 0;
+ const autoBuffered = useEnvelopeSheetValue(envelopeBudget.autoBuffered) ?? 0;
const items = [
...(toBudget > 0
? [
@@ -33,6 +41,10 @@ export function ToBudgetMenu({
name: 'transfer',
text: t('Move to a category'),
},
+ ]
+ : []),
+ ...(autoBuffered === 0
+ ? [
{
name: 'buffer',
text: t('Hold for next month'),
@@ -47,7 +59,15 @@ export function ToBudgetMenu({
},
]
: []),
- ...(forNextMonth > 0
+ ...(forNextMonth > 0 && manualBuffered === 0
+ ? [
+ {
+ name: 'disable-auto-buffer',
+ text: t('Disable current auto hold'),
+ },
+ ]
+ : []),
+ ...(forNextMonth > 0 && manualBuffered !== 0
? [
{
name: 'reset-buffer',
@@ -70,10 +90,14 @@ export function ToBudgetMenu({
break;
case 'buffer':
onHoldBuffer?.();
+ onBudgetAction?.(month, 'reset-income-carryover', {});
break;
case 'reset-buffer':
onResetHoldBuffer?.();
break;
+ case 'disable-auto-buffer':
+ onBudgetAction?.(month, 'reset-income-carryover', {});
+ break;
default:
throw new Error(`Unrecognized menu option: ${name}`);
}
diff --git a/packages/desktop-client/src/components/budget/util.ts b/packages/desktop-client/src/components/budget/util.ts
index a8900cc9dc..9b056909d8 100644
--- a/packages/desktop-client/src/components/budget/util.ts
+++ b/packages/desktop-client/src/components/budget/util.ts
@@ -60,7 +60,7 @@ export function separateGroups(categoryGroups: CategoryGroupEntity[]) {
] as const;
}
-export function makeAmountGrey(value: number | string): CSSProperties {
+export function makeAmountGrey(value: number | string | null): CSSProperties {
return value === 0 || value === '0' || value === '' || value == null
? { color: theme.tableTextSubdued }
: null;
diff --git a/packages/desktop-client/src/components/mobile/budget/IncomeCategoryListItem.tsx b/packages/desktop-client/src/components/mobile/budget/IncomeCategoryListItem.tsx
index 14ec0139f7..d144668358 100644
--- a/packages/desktop-client/src/components/mobile/budget/IncomeCategoryListItem.tsx
+++ b/packages/desktop-client/src/components/mobile/budget/IncomeCategoryListItem.tsx
@@ -18,10 +18,12 @@ import { getColumnWidth, ROW_HEIGHT } from './BudgetTable';
import { useNavigate } from '@desktop-client/hooks/useNavigate';
import { useSyncedPref } from '@desktop-client/hooks/useSyncedPref';
+import { collapseModals, pushModal } from '@desktop-client/modals/modalsSlice';
import {
envelopeBudget,
trackingBudget,
} from '@desktop-client/queries/queries';
+import { useDispatch } from '@desktop-client/redux';
type IncomeCategoryNameProps = {
category: CategoryEntity;
@@ -93,14 +95,14 @@ type IncomeCategoryCellsProps = {
category: CategoryEntity;
month: string;
onBudgetAction: (month: string, action: string, args: unknown) => void;
- onShowActivity: () => void;
+ onPress: () => void;
};
function IncomeCategoryCells({
category,
month,
onBudgetAction,
- onShowActivity,
+ onPress,
}: IncomeCategoryCellsProps) {
const { t } = useTranslation();
const columnWidth = getColumnWidth();
@@ -151,10 +153,16 @@ function IncomeCategoryCells({
<BalanceCell
binding={balance}
category={category}
- onPress={onShowActivity}
- aria-label={t('Show transactions for {{categoryName}} category', {
- categoryName: category.name,
- })}
+ onPress={onPress}
+ aria-label={
+ budgetType === 'envelope'
+ ? t('Open balance menu for {{categoryName}} category', {
+ categoryName: category.name,
+ })
+ : t('Show transactions for {{categoryName}} category', {
+ categoryName: category.name,
+ })
+ }
/>
</View>
</View>
@@ -176,15 +184,59 @@ export function IncomeCategoryListItem({
...props
}: IncomeCategoryListItemProps) {
const { value: category } = props;
+ const dispatch = useDispatch();
const navigate = useNavigate();
+ const [budgetType = 'envelope'] = useSyncedPref('budgetType');
+ const balanceMenuModalName = `envelope-income-balance-menu`;
const onShowActivity = useCallback(() => {
if (!category) {
- return;
+ return null;
}
+
navigate(`/categories/${category.id}?month=${month}`);
}, [category, month, navigate]);
+ const onCarryover = useCallback(
+ (carryover: boolean) => {
+ if (!category) {
+ return;
+ }
+ onBudgetAction(month, 'carryover', {
+ category: category.id,
+ flag: carryover,
+ });
+ dispatch(collapseModals({ rootModalName: balanceMenuModalName }));
+ },
+ [category, onBudgetAction, month, dispatch, balanceMenuModalName],
+ );
+
+ const onOpenBalanceMenu = useCallback(() => {
+ if (!category) {
+ return;
+ }
+ dispatch(
+ pushModal({
+ modal: {
+ name: balanceMenuModalName,
+ options: {
+ month,
+ categoryId: category.id,
+ onCarryover,
+ onShowActivity,
+ },
+ },
+ }),
+ );
+ }, [
+ category,
+ balanceMenuModalName,
+ dispatch,
+ month,
+ onShowActivity,
+ onCarryover,
+ ]);
+
if (!category) {
return null;
}
@@ -213,10 +265,13 @@ export function IncomeCategoryListItem({
>
<IncomeCategoryName category={category} onEdit={onEdit} />
<IncomeCategoryCells
+ key={`${category.id}`}
category={category}
month={month}
onBudgetAction={onBudgetAction}
- onShowActivity={onShowActivity}
+ onPress={
+ budgetType === 'envelope' ? onOpenBalanceMenu : onShowActivity
+ }
/>
</View>
</GridListItem>
diff --git a/packages/desktop-client/src/components/modals/EnvelopeBudgetSummaryModal.tsx b/packages/desktop-client/src/components/modals/EnvelopeBudgetSummaryModal.tsx
index e664f264f1..96e44f6a2c 100644
--- a/packages/desktop-client/src/components/modals/EnvelopeBudgetSummaryModal.tsx
+++ b/packages/desktop-client/src/components/modals/EnvelopeBudgetSummaryModal.tsx
@@ -140,6 +140,7 @@ export function EnvelopeBudgetSummaryModal({
close();
},
onHoldBuffer,
+ onBudgetAction,
},
},
}),
diff --git a/packages/desktop-client/src/components/modals/EnvelopeIncomeBalanceMenuModal.tsx b/packages/desktop-client/src/components/modals/EnvelopeIncomeBalanceMenuModal.tsx
new file mode 100644
index 0000000000..eef9f1f572
--- /dev/null
+++ b/packages/desktop-client/src/components/modals/EnvelopeIncomeBalanceMenuModal.tsx
@@ -0,0 +1,139 @@
+import React, { type CSSProperties } from 'react';
+import { Trans, useTranslation } from 'react-i18next';
+
+import { Menu } from '@actual-app/components/menu';
+import { styles } from '@actual-app/components/styles';
+import { Text } from '@actual-app/components/text';
+import { theme } from '@actual-app/components/theme';
+import { View } from '@actual-app/components/view';
+
+import {
+ BalanceWithCarryover,
+ CarryoverIndicator,
+} from '@desktop-client/components/budget/BalanceWithCarryover';
+import { useEnvelopeSheetValue } from '@desktop-client/components/budget/envelope/EnvelopeBudgetComponents';
+import {
+ Modal,
+ ModalCloseButton,
+ ModalHeader,
+ ModalTitle,
+} from '@desktop-client/components/common/Modal';
+import { CellValueText } from '@desktop-client/components/spreadsheet/CellValue';
+import { useCategory } from '@desktop-client/hooks/useCategory';
+import { type Modal as ModalType } from '@desktop-client/modals/modalsSlice';
+import { envelopeBudget } from '@desktop-client/queries/queries';
+
+type EnvelopeIncomeBalanceMenuModalProps = Omit<
+ Extract<ModalType, { name: 'envelope-income-balance-menu' }>['options'],
+ 'month'
+>;
+
+export function EnvelopeIncomeBalanceMenuModal({
+ categoryId,
+ onCarryover,
+ onShowActivity,
+}: EnvelopeIncomeBalanceMenuModalProps) {
+ const defaultMenuItemStyle: CSSProperties = {
+ ...styles.mobileMenuItem,
+ color: theme.menuItemText,
+ borderRadius: 0,
+ borderTop: `1px solid ${theme.pillBorder}`,
+ };
+
+ const { t } = useTranslation();
+ const category = useCategory(categoryId);
+
+ const carryover = useEnvelopeSheetValue(
+ envelopeBudget.catCarryover(categoryId),
+ );
+
+ if (!category) {
+ return null;
+ }
+
+ return (
+ <Modal name="envelope-income-balance-menu">
+ {({ state: { close } }) => (
+ <>
+ <ModalHeader
+ title={<ModalTitle title={category.name} shrinkOnOverflow />}
+ rightContent={<ModalCloseButton onPress={close} />}
+ />
+ <View
+ style={{
+ justifyContent: 'center',
+ alignItems: 'center',
+ marginBottom: 20,
+ }}
+ >
+ <Text
+ style={{
+ fontSize: 17,
+ fontWeight: 400,
+ }}
+ >
+ <Trans>Balance</Trans>
+ </Text>
+ <BalanceWithCarryover
+ isDisabled
+ shouldInlineGoalStatus
+ carryover={envelopeBudget.catCarryover(categoryId)}
+ balance={envelopeBudget.catBalance(categoryId)}
+ goal={envelopeBudget.catGoal(categoryId)}
+ budgeted={envelopeBudget.catBudgeted(categoryId)}
+ longGoal={envelopeBudget.catLongGoal(categoryId)}
+ CarryoverIndicator={({ style }) => (
+ <CarryoverIndicator
+ style={{
+ width: 15,
+ height: 15,
+ display: 'inline-flex',
+ position: 'relative',
+ ...style,
+ }}
+ />
+ )}
+ >
+ {props => (
+ <CellValueText
+ {...props}
+ style={{
+ textAlign: 'center',
+ ...styles.veryLargeText,
+ }}
+ />
+ )}
+ </BalanceWithCarryover>
+ </View>
+ <Menu
+ getItemStyle={() => defaultMenuItemStyle}
+ onMenuSelect={name => {
+ switch (name) {
+ case 'carryover':
+ onCarryover?.(!carryover);
+ break;
+ case 'view':
+ onShowActivity?.();
+ break;
+ default:
+ throw new Error(`Unrecognized menu option: ${name}`);
+ }
+ }}
+ items={[
+ {
+ name: 'carryover',
+ text: carryover
+ ? t('Disable auto hold')
+ : t('Enable auto hold'),
+ },
+ {
+ name: 'view',
+ text: t('View transactions'),
+ },
+ ]}
+ />
+ </>
+ )}
+ </Modal>
+ );
+}
diff --git a/packages/desktop-client/src/components/modals/EnvelopeToBudgetMenuModal.tsx b/packages/desktop-client/src/components/modals/EnvelopeToBudgetMenuModal.tsx
index 8908aa9430..ce5a3f79c8 100644
--- a/packages/desktop-client/src/components/modals/EnvelopeToBudgetMenuModal.tsx
+++ b/packages/desktop-client/src/components/modals/EnvelopeToBudgetMenuModal.tsx
@@ -11,16 +11,18 @@ import {
} from '@desktop-client/components/common/Modal';
import { type Modal as ModalType } from '@desktop-client/modals/modalsSlice';
-type EnvelopeToBudgetMenuModalProps = Omit<
- Extract<ModalType, { name: 'envelope-summary-to-budget-menu' }>['options'],
- 'month'
->;
+type EnvelopeToBudgetMenuModalProps = Extract<
+ ModalType,
+ { name: 'envelope-summary-to-budget-menu' }
+>['options'];
export function EnvelopeToBudgetMenuModal({
onTransfer,
onCover,
onHoldBuffer,
onResetHoldBuffer,
+ onBudgetAction,
+ month,
}: EnvelopeToBudgetMenuModalProps) {
const defaultMenuItemStyle: CSSProperties = {
...styles.mobileMenuItem,
@@ -43,6 +45,8 @@ export function EnvelopeToBudgetMenuModal({
onCover={onCover}
onHoldBuffer={onHoldBuffer}
onResetHoldBuffer={onResetHoldBuffer}
+ onBudgetAction={onBudgetAction}
+ month={month}
/>
</>
)}
diff --git a/packages/desktop-client/src/components/spreadsheet/index.ts b/packages/desktop-client/src/components/spreadsheet/index.ts
index 7cda16f2b3..c3fc584ef6 100644
--- a/packages/desktop-client/src/components/spreadsheet/index.ts
+++ b/packages/desktop-client/src/components/spreadsheet/index.ts
@@ -35,6 +35,8 @@ export type Spreadsheets = {
'available-funds': number;
'last-month-overspent': number;
buffered: number;
+ 'buffered-auto': number;
+ 'buffered-selected': number;
'to-budget': number | null;
'from-last-month': number;
'total-budgeted': number;
diff --git a/packages/desktop-client/src/modals/modalsSlice.ts b/packages/desktop-client/src/modals/modalsSlice.ts
index b28eb7a6f6..d5c2bdb6dd 100644
--- a/packages/desktop-client/src/modals/modalsSlice.ts
+++ b/packages/desktop-client/src/modals/modalsSlice.ts
@@ -371,12 +371,21 @@ export type Modal =
}
| {
name: 'envelope-balance-menu';
+ options: {
+ categoryId: CategoryEntity['id'];
+ month: string;
+ onCarryover?: (carryover: boolean) => void;
+ onTransfer?: () => void;
+ onCover?: () => void;
+ };
+ }
+ | {
+ name: 'envelope-income-balance-menu';
options: {
categoryId: CategoryEntity['id'];
month: string;
onCarryover: (carryover: boolean) => void;
- onTransfer: () => void;
- onCover: () => void;
+ onShowActivity: () => void;
};
}
| {
@@ -387,6 +396,7 @@ export type Modal =
onCover: () => void;
onHoldBuffer: () => void;
onResetHoldBuffer: () => void;
+ onBudgetAction: (month: string, action: string, arg?: unknown) => void;
};
}
| {
diff --git a/packages/desktop-client/src/queries/queries.ts b/packages/desktop-client/src/queries/queries.ts
index f35e179b43..1670f573ed 100644
--- a/packages/desktop-client/src/queries/queries.ts
+++ b/packages/desktop-client/src/queries/queries.ts
@@ -282,11 +282,13 @@ export function uncategorizedCount<SheetName extends SheetNames>() {
export const envelopeBudget = {
incomeAvailable: 'available-funds',
lastMonthOverspent: 'last-month-overspent',
- forNextMonth: 'buffered',
+ forNextMonth: 'buffered-selected',
totalBudgeted: 'total-budgeted',
toBudget: 'to-budget',
fromLastMonth: 'from-last-month',
+ manualBuffered: 'buffered',
+ autoBuffered: 'buffered-auto',
totalIncome: 'total-income',
totalSpent: 'total-spent',
totalBalance: 'total-leftover',
diff --git a/packages/desktop-client/src/queries/queriesSlice.ts b/packages/desktop-client/src/queries/queriesSlice.ts
index 1ce7cbfc4d..d8f46d07a9 100644
--- a/packages/desktop-client/src/queries/queriesSlice.ts
+++ b/packages/desktop-client/src/queries/queriesSlice.ts
@@ -527,6 +527,11 @@ type ApplyBudgetActionPayload =
flag: boolean;
};
}
+ | {
+ type: 'reset-income-carryover';
+ month: string;
+ args: never;
+ }
| {
type: 'apply-single-category-template';
month: string;
@@ -681,6 +686,9 @@ export const applyBudgetAction = createAppAsyncThunk(
});
break;
}
+ case 'reset-income-carryover':
+ await send('budget/reset-income-carryover', { month });
+ break;
case 'apply-multiple-templates':
dispatch(
addNotification({
diff --git a/packages/loot-core/src/server/budget/actions.ts b/packages/loot-core/src/server/budget/actions.ts
index d895e3e7c3..50142538a6 100644
--- a/packages/loot-core/src/server/budget/actions.ts
+++ b/packages/loot-core/src/server/budget/actions.ts
@@ -599,3 +599,20 @@ async function addMovementNotes({
note: `${existingMonthBudgetNotes}- ${note}`,
});
}
+
+export async function resetIncomeCarryover({
+ month,
+}: {
+ month: string;
+}): Promise<void> {
+ const table = getBudgetTable();
+ const categories = await db.all<db.DbViewCategory>(
+ 'SELECT * FROM v_categories WHERE is_income = 1 AND tombstone = 0',
+ );
+
+ await batchMessages(async () => {
+ for (const category of categories) {
+ await setCarryover(table, category.id, dbMonth(month).toString(), false);
+ }
+ });
+}
diff --git a/packages/loot-core/src/server/budget/app.ts b/packages/loot-core/src/server/budget/app.ts
index 9081308228..1a23673059 100644
--- a/packages/loot-core/src/server/budget/app.ts
+++ b/packages/loot-core/src/server/budget/app.ts
@@ -39,6 +39,7 @@ export interface BudgetHandlers {
'budget/cover-overbudgeted': typeof actions.coverOverbudgeted;
'budget/transfer-category': typeof actions.transferCategory;
'budget/set-carryover': typeof actions.setCategoryCarryover;
+ 'budget/reset-income-carryover': typeof actions.resetIncomeCarryover;
'get-categories': typeof getCategories;
'get-budget-bounds': typeof getBudgetBounds;
'envelope-budget-month': typeof envelopeBudgetMonth;
@@ -120,6 +121,10 @@ app.method(
'budget/set-carryover',
mutator(undoable(actions.setCategoryCarryover)),
);
+app.method(
+ 'budget/reset-income-carryover',
+ mutator(undoable(actions.resetIncomeCarryover)),
+);
app.method('get-categories', getCategories);
app.method('get-budget-bounds', getBudgetBounds);
app.method('envelope-budget-month', envelopeBudgetMonth);
diff --git a/packages/loot-core/src/server/budget/envelope.ts b/packages/loot-core/src/server/budget/envelope.ts
index 759fbc2c76..fd59122768 100644
--- a/packages/loot-core/src/server/budget/envelope.ts
+++ b/packages/loot-core/src/server/budget/envelope.ts
@@ -98,12 +98,16 @@ export function createCategoryGroup(group, sheetName) {
export function createSummary(groups, categories, prevSheetName, sheetName) {
const incomeGroup = groups.filter(group => group.is_income)[0];
const expenseCategories = categories.filter(cat => !cat.is_income);
+ const incomeCategories = categories.filter(cat => cat.is_income);
sheet.get().createStatic(sheetName, 'buffered', 0);
sheet.get().createDynamic(sheetName, 'from-last-month', {
initialValue: 0,
- dependencies: [`${prevSheetName}!to-budget`, `${prevSheetName}!buffered`],
+ dependencies: [
+ `${prevSheetName}!to-budget`,
+ `${prevSheetName}!buffered-selected`,
+ ],
run: (toBudget, buffered) =>
safeNumber(number(toBudget) + number(buffered)),
});
@@ -155,6 +159,36 @@ export function createSummary(groups, categories, prevSheetName, sheetName) {
});
sheet.get().createDynamic(sheetName, 'buffered', { initialValue: 0 });
+ sheet.get().createDynamic(sheetName, 'buffered-auto', {
+ initialValue: 0,
+ dependencies: flatten2(
+ incomeCategories.map(c => [
+ `${sheetName}!sum-amount-${c.id}`,
+ `${sheetName}!carryover-${c.id}`,
+ ]),
+ ),
+ run: (...data) => {
+ data = unflatten2(data);
+ return safeNumber(
+ data.reduce((total, [sumAmount, carryover]) => {
+ if (carryover) {
+ return total + sumAmount;
+ }
+ return total;
+ }, 0),
+ );
+ },
+ });
+ sheet.get().createDynamic(sheetName, 'buffered-selected', {
+ initialValue: 0,
+ dependencies: [`${sheetName}!buffered`, `${sheetName}!buffered-auto`],
+ run: (man, auto) => {
+ if (man !== 0) {
+ return man;
+ }
+ return auto;
+ },
+ });
sheet.get().createDynamic(sheetName, 'to-budget', {
initialValue: 0,
@@ -162,7 +196,7 @@ export function createSummary(groups, categories, prevSheetName, sheetName) {
'available-funds',
'last-month-overspent',
'total-budgeted',
- 'buffered',
+ 'buffered-selected',
],
run: (available, lastOverspent, totalBudgeted, buffered) => {
return safeNumber(
diff --git a/upcoming-release-notes/4778.md b/upcoming-release-notes/4778.md
new file mode 100644
index 0000000000..2b75b97987
--- /dev/null
+++ b/upcoming-release-notes/4778.md
@@ -0,0 +1,6 @@
+---
+category: Features
+authors: [youngcw]
+---
+
+Add ability to automatically hold funds in income categories for future months