'until' template and improved 'starting' template

packages/loot-core/src/server/budget/category-template-context.ts

@@ -335,6 +335,10 @@ export class CategoryTemplateContext {
     // sort the template lines into regular template, goals, and remainder templates
     if (templates) {
       templates.forEach(t => {
+        // Skip expired templates
+        if (CategoryTemplateContext.isTemplateActiveForMonth(t, month)) {
+          return;
+        }
         if (
           t.directive === 'template' &&
           t.type !== 'remainder' &&
@@ -446,6 +450,29 @@ export class CategoryTemplateContext {
     });
   }
 
+  private static isTemplateActiveForMonth(
+    template: Template,
+    month: string,
+  ): boolean {
+    // Check if template hasn't started yet (if starting is set)
+    if ('starting' in template && template.starting) {
+      const startingMonth = template.starting.substring(0, 7);
+      if (monthUtils.differenceInCalendarMonths(month, startingMonth) < 0) {
+        return true;
+      }
+    }
+    // Check if template has expired (if until is set)
+    if ('until' in template && template.until) {
+      // Extract the month part if until is a full date (YYYY-MM-DD), otherwise use as-is (YYYY-MM)
+      const untilMonth = template.until.substring(0, 7);
+      // Return true if current month is after the until month
+      if (monthUtils.differenceInCalendarMonths(month, untilMonth) > 0) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   private checkLimit(templates: Template[]) {
     for (const template of templates.filter(
       t =>
@@ -583,15 +610,33 @@ export class CategoryTemplateContext {
     templateContext: CategoryTemplateContext,
   ): number {
     let toBudget = 0;
+
     const amount = amountToInteger(
       template.amount,
       templateContext.currency.decimalPlaces,
     );
+
     const period = template.period.period;
     const numPeriods = template.period.amount;
+
+    const currentMonth = templateContext.month;
+    const nextMonth = monthUtils.addMonths(currentMonth, 1);
+
+    // Determine start date
+    // let date = template.starting;
     let date =
       template.starting ?? monthUtils.firstDayOfMonth(templateContext.month);
 
+    if (!date) {
+      // Default: first day of current month
+      date = currentMonth.length === 7 ? currentMonth + '-01' : currentMonth;
+    }
+
+    // Normalize YYYY-MM to YYYY-MM-01 for day/week logic
+    if (date.length === 7) {
+      date = date + '-01';
+    }
+
     let dateShiftFunction;
     switch (period) {
       case 'day':
@@ -612,19 +657,27 @@ export class CategoryTemplateContext {
         throw new Error(`Unrecognized periodic period: ${period}`);
     }
 
-    //shift the starting date until its in our month or in the future
-    while (templateContext.month > date) {
+    while (date < currentMonth) {
       date = dateShiftFunction(date, numPeriods);
     }
 
-    if (
-      monthUtils.differenceInCalendarMonths(templateContext.month, date) < 0
-    ) {
+    // Respect until
+    let until = template.until;
+    if (until) {
+      if (until.length === 7) {
+        until = until + '-01';
+      }
+    }
+
+    // If entire period is already after until do nothing
+    if (until && currentMonth > until.substring(0, 7)) {
       return 0;
-    } // nothing needed this month
+    }
 
-    const nextMonth = monthUtils.addMonths(templateContext.month, 1);
+    // Count occurrences inside current month
     while (date < nextMonth) {
+      if (until && date > until) break;
+
       toBudget += amount;
       date = dateShiftFunction(date, numPeriods);
     }

packages/loot-core/src/server/budget/goal-template.pegjs

@@ -1,31 +1,24 @@
 // https://peggyjs.org
 
 expr
-  = template: template _ percentOf:percentOf category: name
-    { return { type: 'percentage', percent: +percentOf.percent, previous: percentOf.prev, category, priority: template.priority, directive: template.directive }}
-  / template: template _ amount: amount _ repeatEvery _ period: periodCount _ starting _ starting: date limit: limit?
-    { return { type: 'periodic', amount, period, starting, limit, priority: template.priority, directive: template.directive }}
-  / template: template _ amount: amount _ by _ month: month from: spendFrom? repeat: (_ repeatEvery _ repeat)?
-    { return {
-      type: from ? 'spend' : 'by',
-      amount,
-      month,
-      ...(repeat ? repeat[3] : {}),
-      from,
-      priority: template.priority, directive: template.directive
-    }}
-  / template: template _ monthly: amount limit: limit?
-    { return { type: 'simple', monthly, limit, priority: template.priority, directive: template.directive }}
-  / template: template _ limit: limit
-    { return { type: 'simple', monthly: null, limit, priority: template.priority, directive: template.directive }}
-  / template: template _ schedule:schedule _ full:full? name:rawScheduleName modifiers:modifiers?
-    { return { type: 'schedule', name: name.trim(), priority: template.priority, directive: template.directive, full, adjustment: modifiers?.adjustment, adjustmentType: modifiers?.adjustmentType  }}
-  / template: template _ remainder: remainder limit: limit?
-    { return { type: 'remainder', priority: null, directive: template.directive, weight: remainder, limit }}
-  / template: template _ 'average'i _ amount: positive _ 'months'i? modifiers:modifiers?
-    { return { type: 'average', numMonths: +amount, priority: template.priority, directive: template.directive, adjustment: modifiers?.adjustment, adjustmentType: modifiers?.adjustmentType  }}
-  / template: template _ 'copy from'i _ lookBack: positive _ 'months ago'i limit:limit?
-    { return { type: 'copy', priority: template.priority, directive: template.directive, lookBack: +lookBack, limit }}
+  = template: template _ percentOf:percentOf category: name starting: startingDate? until:until?
+    { return { type: 'percentage', percent: +percentOf.percent, previous: percentOf.prev, category, starting, until, priority: template.priority, directive: template.directive }}
+  / template: template _ amount: amount _ repeatEvery _ period: periodCount _ starting: startingDate? limit: limit? until: until?
+    { return { type: 'periodic', amount, period, starting: (period.period === 'week' || period.period === 'day') && starting?.length === 7 ? starting + '-01' : starting, limit, until, priority: template.priority, directive: template.directive }}
+  / template: template _ amount: amount _ by _ month: month from: spendFrom? repeat: (_ repeatEvery _ repeat)? starting: startingDate? until: until?
+    { return { type: from ? 'spend' : 'by', amount, month, ...(repeat ? repeat[3] : {}), from, starting, until, priority: template.priority, directive: template.directive }}
+  / template: template _ monthly: amount limit: limit? starting: startingDate? until: until?
+    { return { type: 'simple', monthly, limit, starting, until, priority: template.priority, directive: template.directive }}
+  / template: template _ limit: limit starting: startingDate? until: until?
+    { return { type: 'simple', monthly: null, limit, starting, until, priority: template.priority, directive: template.directive }}
+  / template: template _ schedule:schedule _ full:full? name:rawScheduleName modifiers:modifiers? starting: startingDate? until: until?
+    { return { type: 'schedule', name: name.trim(), priority: template.priority, directive: template.directive, full, adjustment: modifiers?.adjustment, adjustmentType: modifiers?.adjustmentType, starting, until  }}
+  / template: template _ remainder: remainder limit: limit? starting: startingDate? until: until?
+    { return { type: 'remainder', priority: null, directive: template.directive, weight: remainder, limit, starting, until }}
+  / template: template _ 'average'i _ amount: positive _ 'months'i? modifiers:modifiers? starting: startingDate? until: until?
+    { return { type: 'average', numMonths: +amount, priority: template.priority, directive: template.directive, adjustment: modifiers?.adjustment, adjustmentType: modifiers?.adjustmentType, starting, until  }}
+  / template: template _ 'copy from'i _ lookBack: positive _ 'months ago'i limit:limit? starting: startingDate? until: until?
+    { return { type: 'copy', priority: template.priority, directive: template.directive, lookBack: +lookBack, limit, starting, until }}
   / goal: goal amount: amount { return {type: 'goal', amount: amount, priority: null, directive: goal }}
 
 modifiers = _ '[' modifier:modifier ']' { return modifier }
@@ -71,9 +64,10 @@ weeks = 'weeks'i
 by = 'by'i
 of = 'of'i
 repeatEvery = 'repeat'i _ 'every'i
-starting = 'starting'i
+startingDate = _ 'starting'i _ val: $(year '-' d d ('-' d d)?) { return val }
 upTo = 'up'i _ 'to'i
 hold = 'hold'i {return true}
+until = _ 'until'i _ val: $(year '-' d d ('-' d d)?) { return val }
 schedule = 'schedule'i { return text() }
 full = 'full'i _ {return true}
 priority = '-'i number: number {return number}
@@ -96,15 +90,27 @@ date = $(month '-' day)
 currencySymbol 'currency symbol' = symbol: . & { return /\p{Sc}/u.test(symbol) }
 
 // Match schedule name including spaces and brackets, but stop before percentage modifiers
+// Also stop before 'starting' and 'until' keywords
 rawScheduleName = $(
   (
-    !('['('increase'i/'decrease'i)) // Don't start with [increase/decrease
-    [^ \t\r\n]                     // First character can't be whitespace
+    !('['('increase'i/'decrease'i))
+    !(__ 'starting'i (__ / !.))
+    !(__ 'until'i (__ / !.))
+    [^ \t\r\n]
     (
-      !(_ '['('increase'i/'decrease'i)) // Don't match if followed by [increase/decrease modifier
-      [^\r\n]                       // Any character except newlines
+      !(_ '['('increase'i/'decrease'i))
+      !(__ 'starting'i (__ / !.))
+      !(__ 'until'i (__ / !.))
+      [^\r\n]
     )*
   )
 ) { return text().trim() }
 
-name 'Name' = $([^\r\n\t]+) { return text() }
+// Match name but stop before 'starting' and 'until' keywords
+name 'Name' = $(
+  (
+    !('starting'i _)
+    !('until'i _)
+    [^\r\n\t]
+  )+
+) { return text().trim() }

packages/loot-core/src/server/budget/template-notes.test.ts

@@ -51,6 +51,8 @@ describe('storeNoteTemplates', () => {
           type: 'simple',
           monthly: 10,
           limit: null,
+          starting: null,
+          until: null,
           priority: 0,
           directive: 'template',
         },
@@ -71,6 +73,8 @@ describe('storeNoteTemplates', () => {
           type: 'simple',
           monthly: -103.23,
           limit: null,
+          starting: null,
+          until: null,
           priority: 0,
           directive: 'template',
         },
@@ -91,6 +95,8 @@ describe('storeNoteTemplates', () => {
           type: 'simple',
           monthly: 12,
           limit: null,
+          starting: null,
+          until: null,
           priority: 0,
           directive: 'template',
         },
@@ -312,18 +318,35 @@ describe('unparse/parse round-trip', () => {
     '#template up to 25 per day hold',
     '#template up to 100 per week starting 2025-01-01',
     '#template-2 123.45',
+    // simple with starting and until
+    '#template 10 starting 2025-01',
+    '#template 10 until 2025-12',
+    '#template 10 starting 2025-01 until 2025-12',
+    '#template up to 50 until 2025-06',
+    '#template 10 until 2025-12-15',
     // schedule
     '#template schedule Rent',
     '#template schedule full Mortgage',
     '#template schedule Netflix [increase 10%]',
     '#template schedule full Groceries [decrease 5%]',
+    // schedule with starting and until
+    '#template schedule Rent starting 2025-01',
+    '#template schedule Rent until 2025-12',
+    '#template schedule Rent starting 2025-01 until 2025-12',
     // percentage
     '#template 50% of Utilities',
     '#template 75% of previous Dining Out',
+    // percentage with starting and until
+    '#template 50% of Utilities starting 2025-01',
+    '#template 50% of Utilities until 2025-12',
+    '#template 50% of Utilities starting 2025-01 until 2025-12',
     // periodic
     '#template 200 repeat every 2 months starting 2025-06-01',
+    '#template 200 repeat every 2 months starting 2025-06',
     '#template 300 repeat every week starting 2025-01-07',
     '#template 400 repeat every year starting 2025-01-01 up to 50',
+    // periodic with until
+    '#template 200 repeat every 2 months starting 2025-06-01 until 2025-12',
     // by / spend
     '#template 500 by 2025-12',
     '#template 600 by 2025-11 repeat every month',
@@ -332,16 +355,32 @@ describe('unparse/parse round-trip', () => {
     '#template 900 by 2025-08 repeat every 3 years',
     '#template 1000 by 2025-07 spend from 2025-01 repeat every month',
     '#template 1100 by 2025-06 spend from 2025-02 repeat every 2 months',
+    // by / spend with starting and until
+    '#template 500 by 2025-12 starting 2025-01',
+    '#template 500 by 2025-12 until 2026-06',
+    '#template 500 by 2025-12 starting 2025-01 until 2026-06',
     // remainder
     '#template remainder',
     '#template remainder 2',
     '#template remainder 3 up to 10',
+    // remainder with starting and until
+    '#template remainder starting 2025-01',
+    '#template remainder until 2025-12',
+    '#template remainder starting 2025-01 until 2025-12',
     // average
     '#template average 6 months',
     '#template-5 average 12 months',
+    // average with starting and until
+    '#template average 6 months starting 2025-01',
+    '#template average 6 months until 2025-12',
+    '#template average 6 months starting 2025-01 until 2025-12',
     // copy
     '#template copy from 3 months ago',
     '#template copy from 6 months ago',
+    // copy with starting and until
+    '#template copy from 3 months ago starting 2025-01',
+    '#template copy from 3 months ago until 2025-12',
+    '#template copy from 3 months ago starting 2025-01 until 2025-12',
     // goal
     '#goal 1234',
   ];