Skip to content

A local-first personal finance app

Maintenance: Moving some components to Typescript (#1834)

Michael Clark0ec88ecc2497
diff --git a/packages/desktop-client/src/components/Titlebar.tsx b/packages/desktop-client/src/components/Titlebar.tsx
index bab3123ba3..587b3c2f2a 100644
--- a/packages/desktop-client/src/components/Titlebar.tsx
+++ b/packages/desktop-client/src/components/Titlebar.tsx
@@ -41,15 +41,21 @@ import useSheetValue from './spreadsheet/useSheetValue';
import { ThemeSelector } from './ThemeSelector';
import { Tooltip } from './tooltips';
-export let TitlebarContext = createContext(null);
+export type TitlebarContextValue = {
+ sendEvent: (msg: string) => void;
+ subscribe: (listener) => () => void;
+};
+
+export let TitlebarContext = createContext<TitlebarContextValue>(null);
type TitlebarProviderProps = {
children?: ReactNode;
};
+
export function TitlebarProvider({ children }: TitlebarProviderProps) {
let listeners = useRef([]);
- function sendEvent(msg) {
+ function sendEvent(msg: string) {
listeners.current.forEach(func => func(msg));
}
diff --git a/packages/desktop-client/src/components/budget/BudgetPageHeader.js b/packages/desktop-client/src/components/budget/BudgetPageHeader.tsx
similarity index 72%
rename from packages/desktop-client/src/components/budget/BudgetPageHeader.js
rename to packages/desktop-client/src/components/budget/BudgetPageHeader.tsx
index 6f71190116..c5f3576c70 100644
--- a/packages/desktop-client/src/components/budget/BudgetPageHeader.js
+++ b/packages/desktop-client/src/components/budget/BudgetPageHeader.tsx
@@ -1,4 +1,4 @@
-import React, { memo } from 'react';
+import React, { type ComponentProps, memo } from 'react';
import * as monthUtils from 'loot-core/src/shared/months';
@@ -7,8 +7,15 @@ import View from '../common/View';
import { MonthPicker } from './MonthPicker';
import { getScrollbarWidth } from './util';
-const BudgetPageHeader = memo(
- ({ startMonth, onMonthSelect, numMonths, monthBounds, style }) => {
+type BudgetPageHeaderProps = {
+ startMonth: string;
+ onMonthSelect: (month: string) => void;
+ numMonths: number;
+ monthBounds: ComponentProps<typeof MonthPicker>['monthBounds'];
+};
+
+const BudgetPageHeader = memo<BudgetPageHeaderProps>(
+ ({ startMonth, onMonthSelect, numMonths, monthBounds }) => {
function getValidMonth(month) {
let start = monthBounds.start;
let end = monthUtils.subMonths(monthBounds.end, numMonths - 1);
diff --git a/packages/desktop-client/src/components/budget/DynamicBudgetTable.js b/packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx
similarity index 76%
rename from packages/desktop-client/src/components/budget/DynamicBudgetTable.js
rename to packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx
index dbd83c50ab..51ab9df276 100644
--- a/packages/desktop-client/src/components/budget/DynamicBudgetTable.js
+++ b/packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx
@@ -1,4 +1,4 @@
-import React, { forwardRef, useEffect } from 'react';
+import React, { forwardRef, useEffect, type ComponentProps } from 'react';
import { useSelector } from 'react-redux';
import AutoSizer from 'react-virtualized-auto-sizer';
@@ -9,7 +9,7 @@ import { useBudgetMonthCount } from './BudgetMonthCountContext';
import BudgetPageHeader from './BudgetPageHeader';
import BudgetTable from './BudgetTable';
-function getNumPossibleMonths(width) {
+function getNumPossibleMonths(width: number) {
let estimatedTableWidth = width - 200;
if (estimatedTableWidth < 500) {
@@ -27,7 +27,15 @@ function getNumPossibleMonths(width) {
return 6;
}
-const DynamicBudgetTableInner = forwardRef(
+type DynamicBudgetTableInnerProps = {
+ width: number;
+ height: number;
+} & ComponentProps<typeof BudgetTable>;
+
+const DynamicBudgetTableInner = forwardRef<
+ BudgetTable,
+ DynamicBudgetTableInnerProps
+>(
(
{
width,
@@ -92,17 +100,19 @@ const DynamicBudgetTableInner = forwardRef(
},
);
-export default forwardRef((props, ref) => {
- return (
- <AutoSizer>
- {({ width, height }) => (
- <DynamicBudgetTableInner
- ref={ref}
- width={width}
- height={height}
- {...props}
- />
- )}
- </AutoSizer>
- );
-});
+export default forwardRef<BudgetTable, DynamicBudgetTableInnerProps>(
+ (props, ref) => {
+ return (
+ <AutoSizer>
+ {({ width, height }) => (
+ <DynamicBudgetTableInner
+ ref={ref}
+ width={width}
+ height={height}
+ {...props}
+ />
+ )}
+ </AutoSizer>
+ );
+ },
+);
diff --git a/packages/desktop-client/src/components/budget/index.js b/packages/desktop-client/src/components/budget/index.tsx
similarity index 84%
rename from packages/desktop-client/src/components/budget/index.js
rename to packages/desktop-client/src/components/budget/index.tsx
index 65f984d2a0..dbc3f1bf59 100644
--- a/packages/desktop-client/src/components/budget/index.js
+++ b/packages/desktop-client/src/components/budget/index.tsx
@@ -7,29 +7,37 @@ import React, {
useRef,
} from 'react';
import { useSelector } from 'react-redux';
-import { useLocation, useMatch } from 'react-router-dom';
+import {
+ type NavigateFunction,
+ type PathMatch,
+ useLocation,
+ useMatch,
+} from 'react-router-dom';
import { useSpreadsheet } from 'loot-core/src/client/SpreadsheetProvider';
+import { type QueriesState } from 'loot-core/src/client/state-types/queries';
import { send, listen } from 'loot-core/src/platform/client/fetch';
import {
addCategory,
- updateCategory,
moveCategory,
moveCategoryGroup,
+ updateCategory,
deleteCategory,
addGroup,
updateGroup,
deleteGroup,
} from 'loot-core/src/shared/categories';
import * as monthUtils from 'loot-core/src/shared/months';
+import { type Handlers } from 'loot-core/src/types/handlers';
+import { type GlobalPrefs, type LocalPrefs } from 'loot-core/src/types/prefs';
-import { useActions } from '../../hooks/useActions';
+import { type BoundActions, useActions } from '../../hooks/useActions';
import useCategories from '../../hooks/useCategories';
import useFeatureFlag from '../../hooks/useFeatureFlag';
import useNavigate from '../../hooks/useNavigate';
import { styles } from '../../style';
import View from '../common/View';
-import { TitlebarContext } from '../Titlebar';
+import { TitlebarContext, type TitlebarContextValue } from '../Titlebar';
import DynamicBudgetTable from './DynamicBudgetTable';
import { getValidMonthBounds } from './MonthsContext';
@@ -38,7 +46,56 @@ import { ReportProvider } from './report/ReportContext';
import * as rollover from './rollover/rollover-components';
import { RolloverContext } from './rollover/RolloverContext';
-function Budget(props) {
+type ReportComponents = {
+ SummaryComponent: typeof report.BudgetSummary;
+ ExpenseCategoryComponent: typeof report.ExpenseCategoryMonth;
+ ExpenseGroupComponent: typeof report.ExpenseGroupMonth;
+ IncomeCategoryComponent: typeof report.IncomeCategoryMonth;
+ IncomeGroupComponent: typeof report.IncomeGroupMonth;
+ BudgetTotalsComponent: typeof report.BudgetTotalsMonth;
+ IncomeHeaderComponent: typeof report.IncomeHeaderMonth;
+};
+
+type RolloverComponents = {
+ SummaryComponent: typeof RolloverBudgetSummary;
+ ExpenseCategoryComponent: typeof rollover.ExpenseCategoryMonth;
+ ExpenseGroupComponent: typeof rollover.ExpenseGroupMonth;
+ IncomeCategoryComponent: typeof rollover.IncomeCategoryMonth;
+ IncomeGroupComponent: typeof rollover.IncomeGroupMonth;
+ BudgetTotalsComponent: typeof rollover.BudgetTotalsMonth;
+ IncomeHeaderComponent: typeof rollover.IncomeHeaderMonth;
+};
+
+type BudgetProps = {
+ accountId?: string;
+ startMonth: LocalPrefs['budget.startMonth'];
+ collapsedPrefs: LocalPrefs['budget.collapsed'];
+ summaryCollapsed: LocalPrefs['budget.summaryCollapsed'];
+ budgetType: LocalPrefs['budgetType'];
+ maxMonths: GlobalPrefs['maxMonths'];
+ categoryGroups: QueriesState['categories']['grouped'];
+ reportComponents: ReportComponents;
+ rolloverComponents: RolloverComponents;
+ titlebar: TitlebarContextValue;
+ match: PathMatch<string>;
+ spreadsheet: ReturnType<typeof useSpreadsheet>;
+ navigate: NavigateFunction;
+ getCategories: BoundActions['getCategories'];
+ savePrefs: BoundActions['savePrefs'];
+ createCategory: BoundActions['createCategory'];
+ updateCategory: BoundActions['updateCategory'];
+ pushModal: BoundActions['pushModal'];
+ deleteCategory: BoundActions['deleteCategory'];
+ createGroup: BoundActions['createGroup'];
+ updateGroup: BoundActions['updateGroup'];
+ deleteGroup: BoundActions['deleteGroup'];
+ applyBudgetAction: BoundActions['applyBudgetAction'];
+ moveCategory: BoundActions['moveCategory'];
+ moveCategoryGroup: BoundActions['moveCategoryGroup'];
+ loadPrefs: BoundActions['loadPrefs'];
+};
+
+function Budget(props: BudgetProps) {
const currentMonth = monthUtils.currentMonth();
const tableRef = useRef(null);
@@ -130,7 +187,7 @@ function Budget(props) {
const prewarmMonth = async (month, type = null) => {
type = type || props.budgetType;
- let method =
+ let method: keyof Handlers =
type === 'report' ? 'report-budget-month' : 'rollover-budget-month';
let values = await send(method, { month });
@@ -439,7 +496,7 @@ function Budget(props) {
return <View style={{ flex: 1 }}>{table}</View>;
}
-const RolloverBudgetSummary = memo(props => {
+const RolloverBudgetSummary = memo<{ month: string }>(props => {
const isGoalTemplatesEnabled = useFeatureFlag('goalTemplatesEnabled');
return (
<rollover.BudgetSummary
@@ -470,7 +527,7 @@ export default function BudgetWrapper(props) {
let match = useMatch(location.pathname);
let navigate = useNavigate();
- let reportComponents = useMemo(
+ let reportComponents = useMemo<ReportComponents>(
() => ({
SummaryComponent: report.BudgetSummary,
ExpenseCategoryComponent: report.ExpenseCategoryMonth,
@@ -483,7 +540,7 @@ export default function BudgetWrapper(props) {
[report],
);
- let rolloverComponents = useMemo(
+ let rolloverComponents = useMemo<RolloverComponents>(
() => ({
SummaryComponent: RolloverBudgetSummary,
ExpenseCategoryComponent: rollover.ExpenseCategoryMonth,
diff --git a/packages/desktop-client/src/components/budget/rollover/HoldTooltip.tsx b/packages/desktop-client/src/components/budget/rollover/HoldTooltip.tsx
index 74e1228080..0399184d59 100644
--- a/packages/desktop-client/src/components/budget/rollover/HoldTooltip.tsx
+++ b/packages/desktop-client/src/components/budget/rollover/HoldTooltip.tsx
@@ -29,7 +29,7 @@ export default function HoldTooltip({ onSubmit, onClose }: HoldTooltipProps) {
useEffect(() => {
(async () => {
const node = await spreadsheet.get(sheetName, 'to-budget');
- setAmount(integerToCurrency(Math.max(node.value, 0)));
+ setAmount(integerToCurrency(Math.max(node.value as number, 0)));
})();
}, []);
diff --git a/packages/desktop-client/src/components/budget/rollover/TransferTooltip.tsx b/packages/desktop-client/src/components/budget/rollover/TransferTooltip.tsx
index 06e8a099f4..76a4d3b83e 100644
--- a/packages/desktop-client/src/components/budget/rollover/TransferTooltip.tsx
+++ b/packages/desktop-client/src/components/budget/rollover/TransferTooltip.tsx
@@ -51,7 +51,7 @@ export default function TransferTooltip({
(async () => {
if (initialAmountName) {
const node = await spreadsheet.get(sheetName, initialAmountName);
- setAmount(integerToCurrency(Math.max(node.value, 0)));
+ setAmount(integerToCurrency(Math.max(node.value as number, 0)));
} else {
setAmount(integerToCurrency(Math.max(initialAmount, 0)));
}
diff --git a/packages/desktop-client/src/components/table.tsx b/packages/desktop-client/src/components/table.tsx
index 95cb64a876..5962eaba50 100644
--- a/packages/desktop-client/src/components/table.tsx
+++ b/packages/desktop-client/src/components/table.tsx
@@ -306,8 +306,9 @@ const readonlyInputStyle = {
};
type InputValueProps = ComponentProps<typeof Input> & {
- value: string;
+ value?: string;
};
+
function InputValue({
value: defaultValue,
onUpdate,
diff --git a/packages/loot-core/src/client/SpreadsheetProvider.tsx b/packages/loot-core/src/client/SpreadsheetProvider.tsx
index 270cba1923..bb30cda953 100644
--- a/packages/loot-core/src/client/SpreadsheetProvider.tsx
+++ b/packages/loot-core/src/client/SpreadsheetProvider.tsx
@@ -4,7 +4,8 @@ import LRU from 'lru-cache';
import { listen, send } from '../platform/client/fetch';
-const SpreadsheetContext = createContext(undefined);
+type SpreadsheetContextValue = ReturnType<typeof makeSpreadsheet>;
+const SpreadsheetContext = createContext<SpreadsheetContextValue>(undefined);
export function useSpreadsheet() {
return useContext(SpreadsheetContext);
diff --git a/packages/loot-core/src/client/actions/queries.ts b/packages/loot-core/src/client/actions/queries.ts
index 5631fcbdea..c32d1ff5d6 100644
--- a/packages/loot-core/src/client/actions/queries.ts
+++ b/packages/loot-core/src/client/actions/queries.ts
@@ -216,7 +216,7 @@ export function updateGroup(group) {
};
}
-export function deleteGroup(id, transferId) {
+export function deleteGroup(id, transferId?) {
return async function (dispatch, getState) {
await send('category-group-delete', { id, transferId });
await dispatch(getCategories());
diff --git a/packages/loot-core/src/server/spreadsheet/spreadsheet.ts b/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
index 53f62431d5..f098d85cd2 100644
--- a/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
+++ b/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
@@ -5,7 +5,7 @@ import { compileQuery, runCompiledQuery, schema, schemaConfig } from '../aql';
import Graph from './graph-data-structure';
import { unresolveName, resolveName } from './util';
-type Node = {
+export type Node = {
name: string;
expr: string | number | boolean;
value: string | number | boolean;
diff --git a/packages/loot-core/src/types/prefs.d.ts b/packages/loot-core/src/types/prefs.d.ts
index ef97ecf438..67e870f4c3 100644
--- a/packages/loot-core/src/types/prefs.d.ts
+++ b/packages/loot-core/src/types/prefs.d.ts
@@ -26,9 +26,10 @@ export type LocalPrefs = Partial<
'expand-splits': boolean;
[key: `show-extra-balances-${string}`]: boolean;
[key: `hide-cleared-${string}`]: boolean;
- 'budget.collapsed': boolean;
+ 'budget.collapsed': string[];
'budget.summaryCollapsed': boolean;
'budget.showHiddenCategories': boolean;
+ 'budget.startMonth': string;
// TODO: pull from src/components/modals/ImportTransactions.js
[key: `parse-date-${string}-${'csv' | 'qif'}`]: string;
[key: `csv-mappings-${string}`]: string;
diff --git a/packages/loot-core/src/types/server-handlers.d.ts b/packages/loot-core/src/types/server-handlers.d.ts
index 252ec501fe..65d85e18f5 100644
--- a/packages/loot-core/src/types/server-handlers.d.ts
+++ b/packages/loot-core/src/types/server-handlers.d.ts
@@ -3,6 +3,7 @@ import { ParseFileResult } from '../server/accounts/parse-file';
import { batchUpdateTransactions } from '../server/accounts/transactions';
import { Backup } from '../server/backups';
import { RemoteFile } from '../server/cloud-storage';
+import { Node as SpreadsheetNode } from '../server/spreadsheet/spreadsheet';
import { Message } from '../server/sync';
import { AccountEntity, CategoryEntity, CategoryGroupEntity } from './models';
@@ -51,9 +52,19 @@ export interface ServerHandlers {
'get-budget-bounds': () => Promise<{ start: string; end: string }>;
- 'rollover-budget-month': (arg: { month }) => Promise<unknown>;
+ 'rollover-budget-month': (arg: { month }) => Promise<
+ {
+ value: string | number | boolean;
+ name: string;
+ }[]
+ >;
- 'report-budget-month': (arg: { month }) => Promise<unknown>;
+ 'report-budget-month': (arg: { month }) => Promise<
+ {
+ value: string | number | boolean;
+ name: string;
+ }[]
+ >;
'budget-set-type': (arg: { type }) => Promise<unknown>;
@@ -100,7 +111,10 @@ export interface ServerHandlers {
conditions;
}) => Promise<{ filters: unknown[] }>;
- getCell: (arg: { sheetName; name }) => Promise<unknown>;
+ getCell: (arg: {
+ sheetName;
+ name;
+ }) => Promise<SpreadsheetNode | { value?: SpreadsheetNode['value'] }>;
getCells: (arg: { names }) => Promise<unknown>;
diff --git a/upcoming-release-notes/1834.md b/upcoming-release-notes/1834.md
new file mode 100644
index 0000000000..4e74b5e428
--- /dev/null
+++ b/upcoming-release-notes/1834.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MikesGlitch]
+---
+
+Convert Titlebar, BudgetPageHeader, DynamicBudgetTable, Tooltips components to Typescript.