A local-first personal finance app
Renaming variables for reports files (#2069)
Neil8a721bf2e0ec
diff --git a/packages/desktop-client/src/components/reports/ChooseGraph.tsx b/packages/desktop-client/src/components/reports/ChooseGraph.tsxindex ec9630c0f3..ad71b87a1e 100644--- a/packages/desktop-client/src/components/reports/ChooseGraph.tsx+++ b/packages/desktop-client/src/components/reports/ChooseGraph.tsx@@ -21,7 +21,7 @@ type ChooseGraphProps = {graphType: string;balanceType: string;groupBy: string;- empty: boolean;+ showEmpty: boolean;scrollWidth: number;setScrollWidth: (value: number) => void;months: Month[];@@ -32,7 +32,7 @@ export function ChooseGraph({graphType,balanceType,groupBy,- empty,+ showEmpty,scrollWidth,setScrollWidth,months,@@ -104,7 +104,7 @@ export function ChooseGraph({><ReportTableListdata={data}- empty={empty}+ empty={showEmpty}monthsCount={months.length}balanceTypeOp={ReportOptions.balanceTypeMap.get(balanceType)}mode={mode}diff --git a/packages/desktop-client/src/components/reports/ReportOptions.tsx b/packages/desktop-client/src/components/reports/ReportOptions.tsxindex 9c4d811373..2642e63435 100644--- a/packages/desktop-client/src/components/reports/ReportOptions.tsx+++ b/packages/desktop-client/src/components/reports/ReportOptions.tsx@@ -6,8 +6,8 @@ import {} from 'loot-core/src/types/models';const balanceTypeOptions = [- { description: 'Expense', format: 'totalDebts' },- { description: 'Income', format: 'totalAssets' },+ { description: 'Payment', format: 'totalDebts' },+ { description: 'Deposit', format: 'totalAssets' },{ description: 'Net', format: 'totalTotals' },];@@ -21,10 +21,11 @@ const groupByOptions = [];const dateRangeOptions = [- { description: '1 month', name: 1 },- { description: '3 months', name: 2 },- { description: '6 months', name: 5 },- { description: '1 year', name: 11 },+ { description: 'This month', name: 0 },+ { description: 'Last month', name: 1 },+ { description: 'Last 3 months', name: 2 },+ { description: 'Last 6 months', name: 5 },+ { description: 'Last 12 months', name: 11 },{ description: 'Year to date', name: 'yearToDate' },{ description: 'Last year', name: 'lastYear' },{ description: 'All time', name: 'allMonths' },diff --git a/packages/desktop-client/src/components/reports/ReportSidebar.js b/packages/desktop-client/src/components/reports/ReportSidebar.jsindex 5f22d0a13c..c95c79ad59 100644--- a/packages/desktop-client/src/components/reports/ReportSidebar.js+++ b/packages/desktop-client/src/components/reports/ReportSidebar.js@@ -46,8 +46,8 @@ function ModeButton({ selected, children, style, onSelect }) {}export function ReportSidebar({- start,- end,+ startDate,+ endDate,onChangeDates,dateRange,setDateRange,@@ -64,12 +64,12 @@ export function ReportSidebar({setBalanceType,mode,setMode,- empty,- setEmpty,- hidden,- setHidden,- uncat,- setUncat,+ showEmpty,+ setShowEmpty,+ showOffBudgetHidden,+ setShowOffBudgetHidden,+ showUncategorized,+ setShowUncategorized,categories,selectedCategories,setSelectedCategories,@@ -114,7 +114,7 @@ export function ReportSidebar({} else {setTypeDisabled(['Net']);if (['Net'].includes(balanceType)) {- setBalanceType('Expense');+ setBalanceType('Payment');}}if (graphType === 'BarGraph') {@@ -144,7 +144,7 @@ export function ReportSidebar({}}if (['Net'].includes(balanceType) && graphType !== 'TableGraph') {- setBalanceType('Expense');+ setBalanceType('Payment');}};@@ -274,9 +274,9 @@ export function ReportSidebar({<Checkboxid="show-empty-columns"- checked={empty}- value={empty}- onChange={() => setEmpty(!empty)}+ checked={showEmpty}+ value={showEmpty}+ onChange={() => setShowEmpty(!showEmpty)}/><labelhtmlFor="show-empty-columns"@@ -297,9 +297,9 @@ export function ReportSidebar({<Checkboxid="show-hidden-columns"- checked={hidden}- value={hidden}- onChange={() => setHidden(!hidden)}+ checked={showOffBudgetHidden}+ value={showOffBudgetHidden}+ onChange={() => setShowOffBudgetHidden(!showOffBudgetHidden)}/><labelhtmlFor="show-hidden-columns"@@ -320,9 +320,9 @@ export function ReportSidebar({<Checkboxid="show-uncategorized"- checked={uncat}- value={uncat}- onChange={() => setUncat(!uncat)}+ checked={showUncategorized}+ value={showUncategorized}+ onChange={() => setShowUncategorized(!showUncategorized)}/><labelhtmlFor="show-uncategorized"@@ -387,10 +387,10 @@ export function ReportSidebar({</Text><SelectonChange={newValue =>- onChangeDates(...validateStart(allMonths, newValue, end))+ onChangeDates(...validateStart(allMonths, newValue, endDate))}- value={start}- defaultLabel={monthUtils.format(start, 'MMMM, yyyy')}+ value={startDate}+ defaultLabel={monthUtils.format(startDate, 'MMMM, yyyy')}options={allMonths.map(({ name, pretty }) => [name, pretty])}/></View>@@ -406,9 +406,9 @@ export function ReportSidebar({</Text><SelectonChange={newValue =>- onChangeDates(...validateEnd(allMonths, start, newValue))+ onChangeDates(...validateEnd(allMonths, startDate, newValue))}- value={end}+ value={endDate}options={allMonths.map(({ name, pretty }) => [name, pretty])}/></View>diff --git a/packages/desktop-client/src/components/reports/ReportSummary.js b/packages/desktop-client/src/components/reports/ReportSummary.jsindex cfe2e5b709..892bab6f79 100644--- a/packages/desktop-client/src/components/reports/ReportSummary.js+++ b/packages/desktop-client/src/components/reports/ReportSummary.js@@ -13,13 +13,16 @@ import View from '../common/View';import PrivacyFilter from '../PrivacyFilter';export function ReportSummary({- start,- end,+ startDate,+ endDate,data,balanceTypeOp,monthsCount,}) {- const net = data.totalDebts > data.totalAssets ? 'EXPENSE' : 'INCOME';+ const net =+ Math.abs(data.totalDebts) > Math.abs(data.totalAssets)+ ? 'PAYMENT'+ : 'DEPOSIT';const average = amountToInteger(data[balanceTypeOp]) / monthsCount;return (<View@@ -46,8 +49,8 @@ export function ReportSummary({},]}>- {monthUtils.format(start, 'MMM yyyy')} -{' '}- {monthUtils.format(end, 'MMM yyyy')}+ {monthUtils.format(startDate, 'MMM yyyy')} -{' '}+ {monthUtils.format(endDate, 'MMM yyyy')}</Text></View><View@@ -72,7 +75,7 @@ export function ReportSummary({{balanceTypeOp === 'totalDebts'? 'TOTAL SPENDING': balanceTypeOp === 'totalAssets'- ? 'TOTAL INCOME'+ ? 'TOTAL DEPOSITS': 'NET ' + net}</Text><Text@@ -113,7 +116,7 @@ export function ReportSummary({{balanceTypeOp === 'totalDebts'? 'AVERAGE SPENDING': balanceTypeOp === 'totalAssets'- ? 'AVERAGE INCOME'+ ? 'AVERAGE DEPOSIT': 'AVERAGE NET'}</Text><Textdiff --git a/packages/desktop-client/src/components/reports/ReportTableHeader.tsx b/packages/desktop-client/src/components/reports/ReportTableHeader.tsxindex a19554aad4..983495d737 100644--- a/packages/desktop-client/src/components/reports/ReportTableHeader.tsx+++ b/packages/desktop-client/src/components/reports/ReportTableHeader.tsx@@ -73,7 +73,7 @@ export default function ReportTableHeader({minWidth: 85,...styles.tnum,}}- value={'Assets'}+ value={'Deposits'}width="flex"/><Cell@@ -81,7 +81,7 @@ export default function ReportTableHeader({minWidth: 85,...styles.tnum,}}- value={'Debts'}+ value={'Payments'}width="flex"/></>diff --git a/packages/desktop-client/src/components/reports/ReportTopbar.js b/packages/desktop-client/src/components/reports/ReportTopbar.jsindex 61abf5de09..c623a52032 100644--- a/packages/desktop-client/src/components/reports/ReportTopbar.js+++ b/packages/desktop-client/src/components/reports/ReportTopbar.js@@ -59,13 +59,13 @@ export function ReportTopbar({if (mode === 'total') {setGraphType('BarGraph');if (['Net'].includes(balanceType)) {- setBalanceType('Expense');+ setBalanceType('Payment');}setTypeDisabled(['Month', 'Year'].includes(groupBy) ? [] : ['Net']);} else {setGraphType('StackedBarGraph');setTypeDisabled(['Net']);- setBalanceType('Expense');+ setBalanceType('Payment');}}}style={{ marginRight: 15 }}@@ -92,7 +92,7 @@ export function ReportTopbar({onSelect={() => {setGraphType('DonutGraph');setTypeDisabled(['Net']);- setBalanceType('Expense');+ setBalanceType('Payment');}}style={{ marginRight: 15 }}disabled={mode === 'total' ? false : true}diff --git a/packages/desktop-client/src/components/reports/reports/CustomReport.js b/packages/desktop-client/src/components/reports/reports/CustomReport.jsindex 900b181799..55347a8e54 100644--- a/packages/desktop-client/src/components/reports/reports/CustomReport.js+++ b/packages/desktop-client/src/components/reports/reports/CustomReport.js@@ -44,18 +44,18 @@ export default function CustomReport() {const [selectedCategories, setSelectedCategories] = useState(null);const [allMonths, setAllMonths] = useState(null);const [typeDisabled, setTypeDisabled] = useState(['Net']);- const [start, setStart] = useState(+ const [startDate, setStartDate] = useState(monthUtils.subMonths(monthUtils.currentMonth(), 5),);- const [end, setEnd] = useState(monthUtils.currentMonth());+ const [endDate, setEndDate] = useState(monthUtils.currentMonth());const [mode, setMode] = useState('total');const [groupBy, setGroupBy] = useState('Category');- const [balanceType, setBalanceType] = useState('Expense');- const [empty, setEmpty] = useState(false);- const [hidden, setHidden] = useState(false);- const [uncat, setUncat] = useState(false);- const [dateRange, setDateRange] = useState('6 months');+ const [balanceType, setBalanceType] = useState('Payment');+ const [showEmpty, setShowEmpty] = useState(false);+ const [showOffBudgetHidden, setShowOffBudgetHidden] = useState(false);+ const [showUncategorized, setShowUncategorized] = useState(false);+ const [dateRange, setDateRange] = useState('Last 6 months');const [dataCheck, setDataCheck] = useState(false);const [graphType, setGraphType] = useState('BarGraph');@@ -65,7 +65,7 @@ export default function CustomReport() {//const [legend, setLegend] = useState([]);const legend = [];const dateRangeLine = ReportOptions.dateRange.length - 3;- const months = monthUtils.rangeInclusive(start, end);+ const months = monthUtils.rangeInclusive(startDate, endDate);useEffect(() => {if (selectedCategories === null && categories.list.length !== 0) {@@ -107,40 +107,40 @@ export default function CustomReport() {const getGroupData = useMemo(() => {return groupedSpreadsheet({- start,- end,+ startDate,+ endDate,categories,selectedCategories,filters,conditionsOp,- empty,- hidden,- uncat,+ showEmpty,+ showOffBudgetHidden,+ showUncategorized,balanceTypeOp,});}, [- start,- end,+ startDate,+ endDate,categories,selectedCategories,filters,conditionsOp,- hidden,- uncat,+ showOffBudgetHidden,+ showUncategorized,]);const getGraphData = useMemo(() => {setDataCheck(false);return defaultSpreadsheet({- start,- end,+ startDate,+ endDate,categories,selectedCategories,filters,conditionsOp,- empty,- hidden,- uncat,+ showEmpty,+ showOffBudgetHidden,+ showUncategorized,groupBy,balanceTypeOp,payees,@@ -148,8 +148,8 @@ export default function CustomReport() {setDataCheck,});}, [- start,- end,+ startDate,+ endDate,groupBy,balanceType,categories,@@ -158,9 +158,9 @@ export default function CustomReport() {accounts,filters,conditionsOp,- empty,- hidden,- uncat,+ showEmpty,+ showOffBudgetHidden,+ showUncategorized,]);const graphData = useReport('default', getGraphData);const groupedData = useReport('grouped', getGroupData);@@ -173,9 +173,9 @@ export default function CustomReport() {return null;}- const onChangeDates = (start, end) => {- setStart(start);- setEnd(end);+ const onChangeDates = (startDate, endDate) => {+ setStartDate(startDate);+ setEndDate(endDate);};return (@@ -191,8 +191,8 @@ export default function CustomReport() {}}><ReportSidebar- start={start}- end={end}+ startDate={startDate}+ endDate={endDate}onChangeDates={onChangeDates}dateRange={dateRange}setDateRange={setDateRange}@@ -209,12 +209,12 @@ export default function CustomReport() {setBalanceType={setBalanceType}mode={mode}setMode={setMode}- empty={empty}- setEmpty={setEmpty}- hidden={hidden}- setHidden={setHidden}- uncat={uncat}- setUncat={setUncat}+ showEmpty={showEmpty}+ setShowEmpty={setShowEmpty}+ showOffBudgetHidden={showOffBudgetHidden}+ setShowOffBudgetHidden={setShowOffBudgetHidden}+ showUncategorized={showUncategorized}+ setShowUncategorized={setShowUncategorized}categories={categories}selectedCategories={selectedCategories}setSelectedCategories={setSelectedCategories}@@ -308,14 +308,14 @@ export default function CustomReport() {{dataCheck ? (<ChooseGraph- start={start}- end={end}+ startDate={startDate}+ endDate={endDate}data={data}mode={mode}graphType={graphType}balanceType={balanceType}groupBy={groupBy}- empty={empty}+ showEmpty={showEmpty}scrollWidth={scrollWidth}setScrollWidth={setScrollWidth}months={months}@@ -337,8 +337,8 @@ export default function CustomReport() {>{viewSummary && (<ReportSummary- start={start}- end={end}+ startDate={startDate}+ endDate={endDate}balanceTypeOp={balanceTypeOp}data={data}monthsCount={months.length}diff --git a/packages/desktop-client/src/components/reports/reports/CustomReportCard.js b/packages/desktop-client/src/components/reports/reports/CustomReportCard.jsindex b4b3d53114..77f5eccdaf 100644--- a/packages/desktop-client/src/components/reports/reports/CustomReportCard.js+++ b/packages/desktop-client/src/components/reports/reports/CustomReportCard.js@@ -16,19 +16,19 @@ import useReport from '../useReport';function CustomReportCard() {const categories = useCategories();- const end = monthUtils.currentMonth();- const start = monthUtils.subMonths(end, 3);+ const endDate = monthUtils.currentMonth();+ const startDate = monthUtils.subMonths(endDate, 3);const groupBy = 'Category';const getGraphData = useMemo(() => {return defaultSpreadsheet({- start,- end,+ startDate,+ endDate,groupBy,balanceTypeOp: 'totalDebts',categories,});- }, [start, end, categories]);+ }, [startDate, endDate, categories]);const data = useReport('default', getGraphData);return (@@ -42,19 +42,16 @@ function CustomReportCard() {>Custom Report</Block>- <DateRange start={start} end={end} />+ <DateRange start={startDate} end={endDate} /></View></View></View>{data ? (<BarGraph- start={start}- end={end}data={data}compact={true}groupBy={groupBy}- empty={true}balanceTypeOp={'totalDebts'}style={{ height: 'auto', flex: 1 }}/>diff --git a/packages/desktop-client/src/components/reports/spreadsheets/default-spreadsheet.tsx b/packages/desktop-client/src/components/reports/spreadsheets/default-spreadsheet.tsxindex 5d63b02e66..4d17270d4c 100644--- a/packages/desktop-client/src/components/reports/spreadsheets/default-spreadsheet.tsx+++ b/packages/desktop-client/src/components/reports/spreadsheets/default-spreadsheet.tsx@@ -19,15 +19,15 @@ import makeQuery from './makeQuery';import recalculate from './recalculate';export type createSpreadsheetProps = {- start: string;- end: string;+ startDate: string;+ endDate: string;categories: { list: CategoryEntity[]; grouped: CategoryGroupEntity[] };selectedCategories: CategoryEntity[];conditions: RuleConditionEntity[];conditionsOp: string;- empty: boolean;- hidden: boolean;- uncat: boolean;+ showEmpty: boolean;+ showOffBudgetHidden: boolean;+ showUncategorized: boolean;groupBy?: string;balanceTypeOp?: string;payees?: PayeeEntity[];@@ -36,24 +36,28 @@ export type createSpreadsheetProps = {};export default function createSpreadsheet({- start,- end,+ startDate,+ endDate,categories,selectedCategories,conditions = [],conditionsOp,- empty,- hidden,- uncat,+ showEmpty,+ showOffBudgetHidden,+ showUncategorized,groupBy,balanceTypeOp,payees,accounts,setDataCheck,-}) {- const [catList, catGroup] = categoryLists(hidden, uncat, categories);+}: createSpreadsheetProps) {+ const [categoryList, categoryGroup] = categoryLists(+ showOffBudgetHidden,+ showUncategorized,+ categories,+ );- const categoryFilter = (catList || []).filter(+ const categoryFilter = (categoryList || []).filter(category =>!category.hidden &&selectedCategories &&@@ -64,8 +68,8 @@ export default function createSpreadsheet({const [groupByList, groupByLabel] = groupBySelections(groupBy,- catList,- catGroup,+ categoryList,+ categoryGroup,payees,accounts,);@@ -84,9 +88,9 @@ export default function createSpreadsheet({runQuery(makeQuery('assets',- start,- end,- hidden,+ startDate,+ endDate,+ showOffBudgetHidden,selectedCategories,categoryFilter,conditionsOpKey,@@ -96,9 +100,9 @@ export default function createSpreadsheet({runQuery(makeQuery('debts',- start,- end,- hidden,+ startDate,+ endDate,+ showOffBudgetHidden,selectedCategories,categoryFilter,conditionsOpKey,@@ -107,7 +111,7 @@ export default function createSpreadsheet({).then(({ data }) => data),]);- const months = monthUtils.rangeInclusive(start, end);+ const months = monthUtils.rangeInclusive(startDate, endDate);let totalAssets = 0;let totalDebts = 0;@@ -165,12 +169,12 @@ export default function createSpreadsheet({});setData({- data: calcData.filter(i => (!empty ? i[balanceTypeOp] !== 0 : true)),+ data: calcData.filter(i => (!showEmpty ? i[balanceTypeOp] !== 0 : true)),monthData: monthData.filter(i =>- !empty ? i[balanceTypeOp] !== 0 : true,+ !showEmpty ? i[balanceTypeOp] !== 0 : true,),- start,- end,+ startDate,+ endDate,totalDebts: integerToAmount(totalDebts),totalAssets: integerToAmount(totalAssets),totalTotals: integerToAmount(totalAssets + totalDebts),diff --git a/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts b/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.tsindex 445f60a92e..c0199b5a79 100644--- a/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts+++ b/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts@@ -11,20 +11,24 @@ import makeQuery from './makeQuery';import recalculate from './recalculate';function createGroupedSpreadsheet({- start,- end,+ startDate,+ endDate,categories,selectedCategories,conditions = [],conditionsOp,- empty,- hidden,- uncat,+ showEmpty,+ showOffBudgetHidden,+ showUncategorized,balanceTypeOp,}: createSpreadsheetProps) {- const [catList, catGroup] = categoryLists(hidden, uncat, categories);+ const [categoryList, categoryGroup] = categoryLists(+ showOffBudgetHidden,+ showUncategorized,+ categories,+ );- const categoryFilter = (catList || []).filter(+ const categoryFilter = (categoryList || []).filter(category =>!category.hidden &&selectedCategories &&@@ -34,7 +38,7 @@ function createGroupedSpreadsheet({);return async (spreadsheet, setData) => {- if (catList.length === 0) {+ if (categoryList.length === 0) {return null;}@@ -47,9 +51,9 @@ function createGroupedSpreadsheet({runQuery(makeQuery('assets',- start,- end,- hidden,+ startDate,+ endDate,+ showOffBudgetHidden,selectedCategories,categoryFilter,conditionsOpKey,@@ -59,9 +63,9 @@ function createGroupedSpreadsheet({runQuery(makeQuery('debts',- start,- end,- hidden,+ startDate,+ endDate,+ showOffBudgetHidden,selectedCategories,categoryFilter,conditionsOpKey,@@ -70,9 +74,9 @@ function createGroupedSpreadsheet({).then(({ data }) => data),]);- const months = monthUtils.rangeInclusive(start, end);+ const months = monthUtils.rangeInclusive(startDate, endDate);- const groupedData = catGroup.map(+ const groupedData = categoryGroup.map(group => {let totalAssets = 0;let totalDebts = 0;@@ -133,10 +137,11 @@ function createGroupedSpreadsheet({categories: stackedCategories,};},- [start, end],+ [startDate, endDate],+ );+ setData(+ groupedData.filter(i => (!showEmpty ? i[balanceTypeOp] !== 0 : true)),);-- setData(groupedData.filter(i => (!empty ? i[balanceTypeOp] !== 0 : true)));};}diff --git a/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts b/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.tsindex 19d56b811d..2e61c3eb92 100644--- a/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts+++ b/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts@@ -3,9 +3,9 @@ import { type CategoryEntity } from 'loot-core/src/types/models';function makeQuery(name: string,- start: string,- end: string,- hidden: boolean,+ startDate: string,+ endDate: string,+ showOffBudgetHidden: boolean,selectedCategories: CategoryEntity[],categoryFilter: CategoryEntity[],conditionsOpKey: string,@@ -14,7 +14,7 @@ function makeQuery(const query = q('transactions').filter(//Show Offbudget and hidden categories- !hidden && {+ !showOffBudgetHidden && {$and: [{'account.offbudget': false,@@ -54,8 +54,8 @@ function makeQuery(//Apply month range filters.filter({$and: [- { date: { $transform: '$month', $gte: start } },- { date: { $transform: '$month', $lte: end } },+ { date: { $transform: '$month', $gte: startDate } },+ { date: { $transform: '$month', $lte: endDate } },],})//Show assets or debtsdiff --git a/upcoming-release-notes/2069.md b/upcoming-release-notes/2069.mdnew file mode 100644index 0000000000..e8b1f4db82--- /dev/null+++ b/upcoming-release-notes/2069.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [carkom]+---++Updating variable naming for custom reports page.\ No newline at end of file