Skip to content

A local-first personal finance app

✨ Reports - Add an option to trim the start & end intervals (#5641)

Michael Clark80fd9975401b
diff --git a/packages/desktop-client/src/components/reports/ReportOptions.ts b/packages/desktop-client/src/components/reports/ReportOptions.ts
index c3d10d1ebc..cee140f5f1 100644
--- a/packages/desktop-client/src/components/reports/ReportOptions.ts
+++ b/packages/desktop-client/src/components/reports/ReportOptions.ts
@@ -28,6 +28,7 @@ export const defaultReport: CustomReportEntity = {
showHiddenCategories: false,
includeCurrentInterval: true,
showUncategorized: false,
+ trimIntervals: false,
graphType: 'BarGraph',
conditions: [],
conditionsOp: 'and',
diff --git a/packages/desktop-client/src/components/reports/ReportSidebar.tsx b/packages/desktop-client/src/components/reports/ReportSidebar.tsx
index 11ba8956c6..54fa6e4908 100644
--- a/packages/desktop-client/src/components/reports/ReportSidebar.tsx
+++ b/packages/desktop-client/src/components/reports/ReportSidebar.tsx
@@ -51,6 +51,7 @@ type ReportSidebarProps = {
setShowOffBudget: (value: boolean) => void;
setShowHiddenCategories: (value: boolean) => void;
setShowUncategorized: (value: boolean) => void;
+ setTrimIntervals: (value: boolean) => void;
setIncludeCurrentInterval: (value: boolean) => void;
setSelectedCategories: (value: CategoryEntity[]) => void;
onChangeDates: (
@@ -87,6 +88,7 @@ export function ReportSidebar({
setShowHiddenCategories,
setIncludeCurrentInterval,
setShowUncategorized,
+ setTrimIntervals,
setSelectedCategories,
onChangeDates,
onReportChange,
@@ -407,6 +409,12 @@ export function ReportSidebar({
!customReportItems.showUncategorized,
);
setShowUncategorized(!customReportItems.showUncategorized);
+ } else if (type === 'trim-intervals') {
+ setSessionReport(
+ 'trimIntervals',
+ !customReportItems.trimIntervals,
+ );
+ setTrimIntervals(!customReportItems.trimIntervals);
}
}}
items={[
@@ -445,6 +453,14 @@ export function ReportSidebar({
tooltip: t('Show uncategorized transactions'),
toggle: customReportItems.showUncategorized,
},
+ {
+ name: 'trim-intervals',
+ text: t('Trim intervals'),
+ tooltip: t(
+ 'Trim empty intervals at the start and end of the report',
+ ),
+ toggle: customReportItems.trimIntervals,
+ },
]}
/>
</Popover>
diff --git a/packages/desktop-client/src/components/reports/reports/CustomReport.tsx b/packages/desktop-client/src/components/reports/reports/CustomReport.tsx
index 715bbfc76c..eba1135bb0 100644
--- a/packages/desktop-client/src/components/reports/reports/CustomReport.tsx
+++ b/packages/desktop-client/src/components/reports/reports/CustomReport.tsx
@@ -256,6 +256,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
const [showUncategorized, setShowUncategorized] = useState(
loadReport.showUncategorized,
);
+ const [trimIntervals, setTrimIntervals] = useState(loadReport.trimIntervals);
const [graphType, setGraphType] = useState(loadReport.graphType);
const [dateRange, setDateRange] = useState(loadReport.dateRange);
@@ -435,6 +436,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
showOffBudget,
showHiddenCategories,
showUncategorized,
+ trimIntervals,
balanceTypeOp,
sortByOp,
firstDayOfWeekIdx,
@@ -451,6 +453,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
showOffBudget,
showHiddenCategories,
showUncategorized,
+ trimIntervals,
sortByOp,
firstDayOfWeekIdx,
]);
@@ -469,6 +472,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
showOffBudget,
showHiddenCategories,
showUncategorized,
+ trimIntervals,
groupBy,
balanceTypeOp,
sortByOp,
@@ -493,6 +497,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
showOffBudget,
showHiddenCategories,
showUncategorized,
+ trimIntervals,
sortByOp,
graphType,
firstDayOfWeekIdx,
@@ -519,6 +524,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
showHiddenCategories,
includeCurrentInterval,
showUncategorized,
+ trimIntervals,
graphType,
conditions,
conditionsOp,
@@ -664,6 +670,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
setShowHiddenCategories(input.showHiddenCategories);
setIncludeCurrentInterval(input.includeCurrentInterval);
setShowUncategorized(input.showUncategorized);
+ setTrimIntervals(input.trimIntervals);
setGraphType(input.graphType);
onApplyFilter(null);
(input.conditions || []).forEach(condition => onApplyFilter(condition));
@@ -804,6 +811,7 @@ function CustomReportInner({ report: initialReport }: CustomReportInnerProps) {
setShowHiddenCategories={setShowHiddenCategories}
setIncludeCurrentInterval={setIncludeCurrentInterval}
setShowUncategorized={setShowUncategorized}
+ setTrimIntervals={setTrimIntervals}
setSelectedCategories={setSelectedCategories}
onChangeDates={onChangeDates}
onReportChange={onReportChange}
diff --git a/packages/desktop-client/src/components/reports/reports/GetCardData.tsx b/packages/desktop-client/src/components/reports/reports/GetCardData.tsx
index ec1e1f4be2..464c5d4925 100644
--- a/packages/desktop-client/src/components/reports/reports/GetCardData.tsx
+++ b/packages/desktop-client/src/components/reports/reports/GetCardData.tsx
@@ -132,6 +132,7 @@ export function GetCardData({
showOffBudget: report.showOffBudget,
showHiddenCategories: report.showHiddenCategories,
showUncategorized: report.showUncategorized,
+ trimIntervals: report.trimIntervals,
balanceTypeOp: ReportOptions.balanceTypeMap.get(report.balanceType),
firstDayOfWeekIdx,
sortByOp: report.sortBy,
@@ -149,6 +150,7 @@ export function GetCardData({
showOffBudget: report.showOffBudget,
showHiddenCategories: report.showHiddenCategories,
showUncategorized: report.showUncategorized,
+ trimIntervals: report.trimIntervals,
groupBy: report.groupBy,
balanceTypeOp: ReportOptions.balanceTypeMap.get(report.balanceType),
payees,
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts b/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts
index e50959908a..17ce062367 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts
@@ -22,6 +22,11 @@ import { filterHiddenItems } from './filterHiddenItems';
import { makeQuery } from './makeQuery';
import { recalculate } from './recalculate';
import { sortData } from './sortData';
+import {
+ determineIntervalRange,
+ trimIntervalDataToRange,
+ trimIntervalsToRange,
+} from './trimIntervals';
import {
categoryLists,
@@ -44,6 +49,7 @@ export type createCustomSpreadsheetProps = {
showOffBudget: boolean;
showHiddenCategories: boolean;
showUncategorized: boolean;
+ trimIntervals: boolean;
groupBy?: string;
balanceTypeOp?: balanceTypeOpType;
sortByOp?: sortByOpType;
@@ -65,6 +71,7 @@ export function createCustomSpreadsheet({
showOffBudget,
showHiddenCategories,
showUncategorized,
+ trimIntervals,
groupBy = '',
balanceTypeOp = 'totalDebts',
sortByOp = 'desc',
@@ -148,6 +155,7 @@ export function createCustomSpreadsheet({
const groupsByCategory =
groupByLabel === 'category' || groupByLabel === 'categoryGroup';
+
const intervalData = intervals.reduce(
(arr: IntervalEntity[], intervalItem, index) => {
let perIntervalAssets = 0;
@@ -270,16 +278,36 @@ export function createCustomSpreadsheet({
});
return { ...calc };
});
+
+ // First, filter rows so trimming reflects the visible dataset
const calcDataFiltered = calcData.filter(i =>
filterEmptyRows({ showEmpty, data: i, balanceTypeOp }),
);
+ // Determine interval range across filtered groups and main intervalData
+ const { startIndex, endIndex } = determineIntervalRange(
+ calcDataFiltered,
+ intervalData,
+ trimIntervals,
+ balanceTypeOp,
+ );
+
+ // Trim only if enabled
+ const trimmedIntervalData = trimIntervals
+ ? trimIntervalDataToRange(intervalData, startIndex, endIndex)
+ : intervalData;
+
+ if (trimIntervals) {
+ // Keep group data in sync with the trimmed range
+ trimIntervalsToRange(calcDataFiltered, startIndex, endIndex);
+ }
+
const sortedCalcDataFiltered = [...calcDataFiltered].sort(
sortData({ balanceTypeOp, sortByOp }),
);
const legend = calculateLegend(
- intervalData,
+ trimmedIntervalData,
sortedCalcDataFiltered,
groupBy,
graphType,
@@ -288,7 +316,7 @@ export function createCustomSpreadsheet({
setData({
data: sortedCalcDataFiltered,
- intervalData,
+ intervalData: trimmedIntervalData,
legend,
startDate,
endDate,
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts b/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts
index 89bec16af3..066009e7fa 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts
@@ -7,6 +7,10 @@ import { filterEmptyRows } from './filterEmptyRows';
import { makeQuery } from './makeQuery';
import { recalculate } from './recalculate';
import { sortData } from './sortData';
+import {
+ determineIntervalRange,
+ trimGroupedDataIntervals,
+} from './trimIntervals';
import {
categoryLists,
@@ -27,6 +31,7 @@ export function createGroupedSpreadsheet({
showOffBudget,
showHiddenCategories,
showUncategorized,
+ trimIntervals,
balanceTypeOp,
sortByOp,
firstDayOfWeekIdx,
@@ -142,6 +147,25 @@ export function createGroupedSpreadsheet({
filterEmptyRows({ showEmpty, data: i, balanceTypeOp }),
);
+ // Determine interval range across all groups and their nested categories
+ const allGroupsForTrimming: GroupedEntity[] = [];
+ groupedDataFiltered.forEach(group => {
+ allGroupsForTrimming.push(group);
+ if (group.categories) {
+ allGroupsForTrimming.push(...group.categories);
+ }
+ });
+
+ const { startIndex, endIndex } = determineIntervalRange(
+ allGroupsForTrimming,
+ groupedDataFiltered.length > 0 ? groupedDataFiltered[0].intervalData : [],
+ trimIntervals,
+ balanceTypeOp,
+ );
+
+ // Trim all groupedData intervals (including nested categories) based on the range
+ trimGroupedDataIntervals(groupedDataFiltered, startIndex, endIndex);
+
const sortedGroupedDataFiltered = [...groupedDataFiltered]
.sort(sortData({ balanceTypeOp, sortByOp }))
.map(g => {
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/trimIntervals.ts b/packages/desktop-client/src/components/reports/spreadsheets/trimIntervals.ts
new file mode 100644
index 0000000000..6abf3114c7
--- /dev/null
+++ b/packages/desktop-client/src/components/reports/spreadsheets/trimIntervals.ts
@@ -0,0 +1,153 @@
+import {
+ type GroupedEntity,
+ type IntervalEntity,
+ type balanceTypeOpType,
+} from 'loot-core/types/models';
+
+function isEmptyForMetric(
+ interval: IntervalEntity,
+ metric: balanceTypeOpType,
+): boolean {
+ switch (metric) {
+ case 'totalAssets':
+ return interval.totalAssets === 0;
+ case 'totalDebts':
+ return interval.totalDebts === 0;
+ case 'netAssets':
+ return interval.netAssets === 0;
+ case 'netDebts':
+ return interval.netDebts === 0;
+ case 'totalTotals':
+ default:
+ return interval.totalTotals === 0;
+ }
+}
+
+export function determineIntervalRange(
+ data: GroupedEntity[],
+ intervalData: IntervalEntity[],
+ trimIntervals: boolean,
+ balanceTypeOp: balanceTypeOpType = 'totalTotals',
+): { startIndex: number; endIndex: number } {
+ if (!trimIntervals || intervalData.length === 0) {
+ return { startIndex: 0, endIndex: intervalData.length - 1 };
+ }
+
+ let globalStartIndex = intervalData.length;
+ let globalEndIndex = -1;
+
+ // Check each group to find the earliest start and latest end of non-empty data
+ data.forEach(item => {
+ const startIndex = item.intervalData.findIndex(
+ interval => !isEmptyForMetric(interval, balanceTypeOp),
+ );
+
+ if (startIndex !== -1) {
+ globalStartIndex = Math.min(globalStartIndex, startIndex);
+
+ // Find last non-empty interval for this group
+ let endIndex = item.intervalData.length - 1;
+ while (
+ endIndex >= 0 &&
+ isEmptyForMetric(item.intervalData[endIndex], balanceTypeOp)
+ ) {
+ endIndex--;
+ }
+ globalEndIndex = Math.max(globalEndIndex, endIndex);
+ }
+ });
+
+ // Also check the main intervalData for any activity
+ const mainStartIndex = intervalData.findIndex(
+ interval => !isEmptyForMetric(interval, balanceTypeOp),
+ );
+ if (mainStartIndex !== -1) {
+ globalStartIndex = Math.min(globalStartIndex, mainStartIndex);
+
+ let mainEndIndex = intervalData.length - 1;
+
+ while (
+ mainEndIndex >= 0 &&
+ isEmptyForMetric(intervalData[mainEndIndex], balanceTypeOp)
+ ) {
+ mainEndIndex--;
+ }
+ globalEndIndex = Math.max(globalEndIndex, mainEndIndex);
+ }
+
+ // If no non-empty intervals found anywhere, return empty range
+ if (globalStartIndex === intervalData.length || globalEndIndex === -1) {
+ return { startIndex: 0, endIndex: -1 };
+ }
+
+ return { startIndex: globalStartIndex, endIndex: globalEndIndex };
+}
+
+export function trimIntervalDataToRange(
+ data: IntervalEntity[],
+ startIndex: number,
+ endIndex: number,
+): IntervalEntity[] {
+ // Trim empty interval data from the start and end based on the range
+ if (startIndex > endIndex || startIndex < 0 || endIndex >= data.length) {
+ return [];
+ }
+ return data.slice(startIndex, endIndex + 1);
+}
+
+export function trimIntervalsToRange(
+ data: GroupedEntity[],
+ startIndex: number,
+ endIndex: number,
+): void {
+ // Trims intervalData for each GroupedEntity based on range
+ data.forEach(item => {
+ if (
+ startIndex > endIndex ||
+ startIndex < 0 ||
+ endIndex >= item.intervalData.length
+ ) {
+ item.intervalData = [];
+ } else {
+ item.intervalData = item.intervalData.slice(startIndex, endIndex + 1);
+ }
+ });
+}
+
+// Trim nested category intervalData within each group
+export function trimGroupedDataIntervals(
+ groupedData: GroupedEntity[],
+ startIndex: number,
+ endIndex: number,
+): void {
+ groupedData.forEach(group => {
+ // Trim the group's own intervalData
+ if (
+ startIndex > endIndex ||
+ startIndex < 0 ||
+ endIndex >= group.intervalData.length
+ ) {
+ group.intervalData = [];
+ } else {
+ group.intervalData = group.intervalData.slice(startIndex, endIndex + 1);
+ }
+
+ // Trim the nested categories' intervalData
+ if (group.categories) {
+ group.categories.forEach(category => {
+ if (
+ startIndex > endIndex ||
+ startIndex < 0 ||
+ endIndex >= category.intervalData.length
+ ) {
+ category.intervalData = [];
+ } else {
+ category.intervalData = category.intervalData.slice(
+ startIndex,
+ endIndex + 1,
+ );
+ }
+ });
+ }
+ });
+}
diff --git a/packages/desktop-client/src/hooks/useReports.ts b/packages/desktop-client/src/hooks/useReports.ts
index 81f782b7fc..ce55db12b5 100644
--- a/packages/desktop-client/src/hooks/useReports.ts
+++ b/packages/desktop-client/src/hooks/useReports.ts
@@ -27,6 +27,7 @@ function toJS(rows: CustomReportData[]) {
showHiddenCategories: row.show_hidden === 1,
includeCurrentInterval: row.include_current === 1,
showUncategorized: row.show_uncategorized === 1,
+ trimIntervals: row.trim_intervals === 1,
graphType: row.graph_type,
...(row.conditions && { conditions: row.conditions }),
conditionsOp: row.conditions_op ?? 'and',
diff --git a/packages/loot-core/migrations/1759260219000_add_trim_interval_report_setting.sql b/packages/loot-core/migrations/1759260219000_add_trim_interval_report_setting.sql
new file mode 100644
index 0000000000..f7b9e6dbaa
--- /dev/null
+++ b/packages/loot-core/migrations/1759260219000_add_trim_interval_report_setting.sql
@@ -0,0 +1,6 @@
+-- Migration: Add trim_intervals column to custom_reports table
+BEGIN TRANSACTION;
+
+ALTER TABLE custom_reports ADD COLUMN trim_intervals INTEGER DEFAULT 0;
+
+COMMIT;
diff --git a/packages/loot-core/src/server/aql/schema/index.ts b/packages/loot-core/src/server/aql/schema/index.ts
index 00262f2b8e..83b4062c13 100644
--- a/packages/loot-core/src/server/aql/schema/index.ts
+++ b/packages/loot-core/src/server/aql/schema/index.ts
@@ -154,6 +154,7 @@ export const schema = {
show_offbudget: f('integer', { default: 0 }),
show_hidden: f('integer', { default: 0 }),
show_uncategorized: f('integer', { default: 0 }),
+ trim_intervals: f('integer', { default: 0 }),
include_current: f('integer', { default: 0 }),
graph_type: f('string', { default: 'BarGraph' }),
conditions: f('json'),
diff --git a/packages/loot-core/src/server/reports/app.ts b/packages/loot-core/src/server/reports/app.ts
index a252e25d37..4c4c37e325 100644
--- a/packages/loot-core/src/server/reports/app.ts
+++ b/packages/loot-core/src/server/reports/app.ts
@@ -46,6 +46,7 @@ export const reportModel = {
showOffBudget: row.show_offbudget === 1,
showHiddenCategories: row.show_hidden === 1,
showUncategorized: row.show_uncategorized === 1,
+ trimIntervals: row.trim_intervals === 1,
includeCurrentInterval: row.include_current === 1,
graphType: row.graph_type,
conditions: row.conditions,
@@ -69,7 +70,7 @@ export const reportModel = {
show_empty: report.showEmpty ? 1 : 0,
show_offbudget: report.showOffBudget ? 1 : 0,
show_hidden: report.showHiddenCategories ? 1 : 0,
- show_uncategorized: report.showUncategorized ? 1 : 0,
+ trim_intervals: report.trimIntervals ? 1 : 0,
include_current: report.includeCurrentInterval ? 1 : 0,
graph_type: report.graphType,
conditions: report.conditions,
diff --git a/packages/loot-core/src/types/models/reports.ts b/packages/loot-core/src/types/models/reports.ts
index caa48847e3..0b5b1346de 100644
--- a/packages/loot-core/src/types/models/reports.ts
+++ b/packages/loot-core/src/types/models/reports.ts
@@ -17,6 +17,7 @@ export interface CustomReportEntity {
showHiddenCategories: boolean;
includeCurrentInterval: boolean;
showUncategorized: boolean;
+ trimIntervals: boolean;
graphType: string;
conditions?: RuleConditionEntity[];
conditionsOp: 'and' | 'or';
@@ -132,6 +133,7 @@ export interface CustomReportData {
show_hidden: number;
include_current: number;
show_uncategorized: number;
+ trim_intervals: number;
graph_type: string;
conditions?: RuleConditionEntity[];
conditions_op: 'and' | 'or';
diff --git a/upcoming-release-notes/5641.md b/upcoming-release-notes/5641.md
new file mode 100644
index 0000000000..ce1f72a451
--- /dev/null
+++ b/upcoming-release-notes/5641.md
@@ -0,0 +1,6 @@
+---
+category: Features
+authors: [MikesGlitch]
+---
+
+Add option to 'trim intervals' to remove empty start/end intervals on custom reports