[AI] Add option to 'Copy [budget] to future months'

packages/desktop-client/src/budget/mutations.ts

@@ -647,6 +647,13 @@ type ApplyBudgetActionPayload =
       args: {
         category: CategoryEntity['id'];
       };
+    }
+  | {
+      type: 'copy-to-future-months';
+      month: string;
+      args: {
+        category: CategoryEntity['id'];
+      };
     };
 
 export function useBudgetActions() {
@@ -776,6 +783,12 @@ export function useBudgetActions() {
             category: args.category,
           });
           return null;
+        case 'copy-to-future-months':
+          await send('budget/copy-to-future-months', {
+            month,
+            category: args.category,
+          });
+          return null;
         default:
           throw new Error(`Unknown budget action type: ${String(type)}`);
       }

packages/desktop-client/src/components/budget/envelope/BudgetMenu.tsx

@@ -13,11 +13,13 @@ type BudgetMenuProps = Omit<
   onCopyLastMonthAverage: () => void;
   onSetMonthsAverage: (numberOfMonths: number) => void;
   onApplyBudgetTemplate: () => void;
+  onCopyToFutureMonths: () => void;
 };
 export function BudgetMenu({
   onCopyLastMonthAverage,
   onSetMonthsAverage,
   onApplyBudgetTemplate,
+  onCopyToFutureMonths,
   ...props
 }: BudgetMenuProps) {
   const { t } = useTranslation();
@@ -40,6 +42,9 @@ export function BudgetMenu({
       case 'apply-single-category-template':
         onApplyBudgetTemplate?.();
         break;
+      case 'copy-to-future-months':
+        onCopyToFutureMonths?.();
+        break;
       default:
         throw new Error(`Unrecognized menu item: ${name}`);
     }
@@ -66,6 +71,10 @@ export function BudgetMenu({
           name: 'set-single-12-avg',
           text: t('Set to yearly average'),
         },
+        {
+          name: 'copy-to-future-months',
+          text: t('Copy to future months'),
+        },
         ...(isGoalTemplatesEnabled
           ? [
               {

packages/desktop-client/src/components/budget/envelope/EnvelopeBudgetComponents.tsx

@@ -367,6 +367,14 @@ export const ExpenseCategoryMonth = memo(function ExpenseCategoryMonth({
                       message: t(`Budget template applied.`),
                     });
                   }}
+                  onCopyToFutureMonths={() => {
+                    onMenuAction(month, 'copy-to-future-months', {
+                      category: category.id,
+                    });
+                    showUndoNotification({
+                      message: t(`Budget copied to future months.`),
+                    });
+                  }}
                 />
               </Popover>
             </View>

packages/desktop-client/src/components/budget/tracking/BudgetMenu.tsx

@@ -13,11 +13,13 @@ type BudgetMenuProps = Omit<
   onCopyLastMonthAverage: () => void;
   onSetMonthsAverage: (numberOfMonths: number) => void;
   onApplyBudgetTemplate: () => void;
+  onCopyToFutureMonths: () => void;
 };
 export function BudgetMenu({
   onCopyLastMonthAverage,
   onSetMonthsAverage,
   onApplyBudgetTemplate,
+  onCopyToFutureMonths,
   ...props
 }: BudgetMenuProps) {
   const { t } = useTranslation();
@@ -39,6 +41,9 @@ export function BudgetMenu({
       case 'apply-single-category-template':
         onApplyBudgetTemplate?.();
         break;
+      case 'copy-to-future-months':
+        onCopyToFutureMonths?.();
+        break;
       default:
         throw new Error(`Unrecognized menu item: ${name}`);
     }
@@ -65,6 +70,10 @@ export function BudgetMenu({
           name: 'set-single-12-avg',
           text: t('Set to yearly average'),
         },
+        {
+          name: 'copy-to-future-months',
+          text: t('Copy to future months'),
+        },
         ...(isGoalTemplatesEnabled
           ? [
               {

packages/desktop-client/src/components/budget/tracking/TrackingBudgetComponents.tsx

@@ -344,6 +344,14 @@ export const CategoryMonth = memo(function CategoryMonth({
                       message: t(`Budget template applied.`),
                     });
                   }}
+                  onCopyToFutureMonths={() => {
+                    onMenuAction(month, 'copy-to-future-months', {
+                      category: category.id,
+                    });
+                    showUndoNotification({
+                      message: t(`Budget copied to future months.`),
+                    });
+                  }}
                 />
               </Popover>
             </View>

packages/desktop-client/src/components/mobile/budget/BudgetCell.tsx

@@ -130,6 +130,14 @@ export function BudgetCell<
                 pre: categoryNotes ?? undefined,
               });
             },
+            onCopyToFutureMonths: () => {
+              onBudgetAction(month, 'copy-to-future-months', {
+                category: category.id,
+              });
+              showUndoNotification({
+                message: `${category.name} budget copied to future months.`,
+              });
+            },
           },
         },
       }),

packages/desktop-client/src/components/modals/EnvelopeBudgetMenuModal.tsx

@@ -42,6 +42,7 @@ export function EnvelopeBudgetMenuModal({
   onCopyLastMonthAverage,
   onSetMonthsAverage,
   onApplyBudgetTemplate,
+  onCopyToFutureMonths,
   onEditNotes,
   month,
 }: EnvelopeBudgetMenuModalProps) {
@@ -200,6 +201,7 @@ export function EnvelopeBudgetMenuModal({
               onCopyLastMonthAverage={onCopyLastMonthAverage}
               onSetMonthsAverage={onSetMonthsAverage}
               onApplyBudgetTemplate={onApplyBudgetTemplate}
+              onCopyToFutureMonths={onCopyToFutureMonths}
             />
           )}
         </>

packages/desktop-client/src/components/modals/TrackingBudgetMenuModal.tsx

@@ -42,6 +42,7 @@ export function TrackingBudgetMenuModal({
   onCopyLastMonthAverage,
   onSetMonthsAverage,
   onApplyBudgetTemplate,
+  onCopyToFutureMonths,
   onEditNotes,
   month,
 }: TrackingBudgetMenuModalProps) {
@@ -200,6 +201,7 @@ export function TrackingBudgetMenuModal({
               onCopyLastMonthAverage={onCopyLastMonthAverage}
               onSetMonthsAverage={onSetMonthsAverage}
               onApplyBudgetTemplate={onApplyBudgetTemplate}
+              onCopyToFutureMonths={onCopyToFutureMonths}
             />
           )}
         </>

packages/desktop-client/src/modals/modalsSlice.ts

@@ -344,6 +344,7 @@ export type Modal =
         onCopyLastMonthAverage: () => void;
         onSetMonthsAverage: (numberOfMonths: number) => void;
         onApplyBudgetTemplate: () => void;
+        onCopyToFutureMonths: () => void;
         onEditNotes: (id: NoteEntity['id'], month: string) => void;
       };
     }
@@ -356,6 +357,7 @@ export type Modal =
         onCopyLastMonthAverage: () => void;
         onSetMonthsAverage: (numberOfMonths: number) => void;
         onApplyBudgetTemplate: () => void;
+        onCopyToFutureMonths: () => void;
         onEditNotes: (id: NoteEntity['id'], month: string) => void;
       };
     }

packages/loot-core/src/server/budget/actions.test.ts

@@ -4,13 +4,94 @@ import * as db from '#server/db';
 import * as sheet from '#server/sheet';
 
 import {
+  copyToFutureMonths,
   coverOverbudgeted,
   getSheetValue,
   setBudget,
   setCategoryCarryover,
 } from './actions';
 import * as budget from './base';
 
+describe('copyToFutureMonths', () => {
+  beforeEach(global.emptyDatabase());
+  afterEach(global.emptyDatabase());
+
+  async function setupDatabase() {
+    await db.insertCategoryGroup({
+      id: 'income-group',
+      name: 'Income',
+      is_income: 1,
+    });
+    await db.insertCategory({
+      id: 'income-cat',
+      name: 'Income',
+      cat_group: 'income-group',
+      is_income: 1,
+    });
+    await db.insertCategoryGroup({
+      id: 'group1',
+      name: 'group1',
+      is_income: 0,
+    });
+    await db.insertCategory({
+      id: 'cat1',
+      name: 'cat1',
+      cat_group: 'group1',
+      is_income: 0,
+    });
+    await sheet.loadSpreadsheet(db);
+    await budget.createBudget(['2024-01', '2024-02', '2024-03']);
+  }
+
+  it('copies the current month budget to future months with non-zero budgets', async () => {
+    await setupDatabase();
+
+    await setBudget({ category: 'cat1', month: '2024-01', amount: 5000 });
+    await setBudget({ category: 'cat1', month: '2024-02', amount: 1000 });
+    await setBudget({ category: 'cat1', month: '2024-03', amount: 2000 });
+    await sheet.waitOnSpreadsheet();
+
+    await copyToFutureMonths({ month: '2024-01', category: 'cat1' });
+    await sheet.waitOnSpreadsheet();
+
+    expect(await getSheetValue('budget202401', 'budget-cat1')).toBe(5000);
+    expect(await getSheetValue('budget202402', 'budget-cat1')).toBe(5000);
+    expect(await getSheetValue('budget202403', 'budget-cat1')).toBe(5000);
+  });
+
+  it('skips future months with empty (zero) budgets', async () => {
+    await setupDatabase();
+
+    await setBudget({ category: 'cat1', month: '2024-01', amount: 5000 });
+    // 2024-02 intentionally left at 0
+    await setBudget({ category: 'cat1', month: '2024-03', amount: 2000 });
+    await sheet.waitOnSpreadsheet();
+
+    await copyToFutureMonths({ month: '2024-01', category: 'cat1' });
+    await sheet.waitOnSpreadsheet();
+
+    expect(await getSheetValue('budget202401', 'budget-cat1')).toBe(5000);
+    expect(await getSheetValue('budget202402', 'budget-cat1')).toBe(0);
+    expect(await getSheetValue('budget202403', 'budget-cat1')).toBe(5000);
+  });
+
+  it('does not affect months before or equal to the current month', async () => {
+    await setupDatabase();
+
+    await setBudget({ category: 'cat1', month: '2024-01', amount: 1000 });
+    await setBudget({ category: 'cat1', month: '2024-02', amount: 5000 });
+    await setBudget({ category: 'cat1', month: '2024-03', amount: 2000 });
+    await sheet.waitOnSpreadsheet();
+
+    await copyToFutureMonths({ month: '2024-02', category: 'cat1' });
+    await sheet.waitOnSpreadsheet();
+
+    expect(await getSheetValue('budget202401', 'budget-cat1')).toBe(1000);
+    expect(await getSheetValue('budget202402', 'budget-cat1')).toBe(5000);
+    expect(await getSheetValue('budget202403', 'budget-cat1')).toBe(5000);
+  });
+});
+
 describe('coverOverbudgeted', () => {
   beforeEach(global.emptyDatabase());
   afterEach(global.emptyDatabase());

packages/loot-core/src/server/budget/actions.ts

@@ -591,6 +591,36 @@ export async function transferCategory({
   });
 }
 
+export async function copyToFutureMonths({
+  month,
+  category,
+}: {
+  month: string;
+  category: string;
+}): Promise<void> {
+  const amount = await getSheetValue(
+    monthUtils.sheetForMonth(month),
+    'budget-' + category,
+  );
+
+  const { createdMonths } = sheet.get().meta();
+  const futureMonths = [...(createdMonths as Set<string>)]
+    .filter(m => m > month)
+    .sort();
+
+  await batchMessages(async () => {
+    for (const futureMonth of futureMonths) {
+      const existing = await getSheetValue(
+        monthUtils.sheetForMonth(futureMonth),
+        'budget-' + category,
+      );
+      if (existing !== 0) {
+        void setBudget({ category, month: futureMonth, amount });
+      }
+    }
+  });
+}
+
 export async function setCategoryCarryover({
   startMonth,
   category,

packages/loot-core/src/server/budget/app.ts

@@ -39,6 +39,7 @@ export type BudgetHandlers = {
   'budget/transfer-available': typeof actions.transferAvailable;
   'budget/cover-overbudgeted': typeof actions.coverOverbudgeted;
   'budget/transfer-category': typeof actions.transferCategory;
+  'budget/copy-to-future-months': typeof actions.copyToFutureMonths;
   'budget/set-carryover': typeof actions.setCategoryCarryover;
   'budget/reset-income-carryover': typeof actions.resetIncomeCarryover;
   'get-categories': typeof getCategories;
@@ -122,6 +123,10 @@ app.method(
   'budget/transfer-category',
   mutator(undoable(actions.transferCategory)),
 );
+app.method(
+  'budget/copy-to-future-months',
+  mutator(undoable(actions.copyToFutureMonths)),
+);
 app.method(
   'budget/set-carryover',
   mutator(undoable(actions.setCategoryCarryover)),

upcoming-release-notes/7420.md

@@ -0,0 +1,6 @@
+---
+category: Features
+authors: [nikhilweee]
+---
+
+Add 'Copy to future months' option to the per-category budget menu, which copies the current month's budgeted amount to all subsequent months that already exist in the budget.