Skip to content

A local-first personal finance app

[Maintenance] Refactor payee table to typescript (#1948)

Kyle Mckay3306963c54ad
diff --git a/packages/desktop-client/src/components/payees/ManagePayees.js b/packages/desktop-client/src/components/payees/ManagePayees.js
index 8b2762b687..0f8f968555 100644
--- a/packages/desktop-client/src/components/payees/ManagePayees.js
+++ b/packages/desktop-client/src/components/payees/ManagePayees.js
@@ -15,8 +15,8 @@ import { groupById } from 'loot-core/src/shared/util';
import useSelected, {
SelectedProvider,
- useSelectedItems,
useSelectedDispatch,
+ useSelectedItems,
} from '../../hooks/useSelected';
import useStableCallback from '../../hooks/useStableCallback';
import ExpandArrow from '../../icons/v0/ExpandArrow';
@@ -308,7 +308,6 @@ export const ManagePayees = forwardRef(
payees={filteredPayees}
ruleCounts={ruleCounts}
categoryGroups={categoryGroups}
- highlightedRows={highlightedRows}
navigator={tableNavigator}
onUpdate={onUpdate}
onViewRules={onViewRules}
diff --git a/packages/desktop-client/src/components/payees/PayeeMenu.js b/packages/desktop-client/src/components/payees/PayeeMenu.tsx
similarity index 85%
rename from packages/desktop-client/src/components/payees/PayeeMenu.js
rename to packages/desktop-client/src/components/payees/PayeeMenu.tsx
index 3d261a4b67..cb13de4be2 100644
--- a/packages/desktop-client/src/components/payees/PayeeMenu.js
+++ b/packages/desktop-client/src/components/payees/PayeeMenu.tsx
@@ -1,3 +1,5 @@
+import { type PayeeEntity } from 'loot-core/src/types/models';
+
import Delete from '../../icons/v0/Delete';
import Merge from '../../icons/v0/Merge';
import { theme } from '../../style';
@@ -5,13 +7,21 @@ import Menu from '../common/Menu';
import View from '../common/View';
import { Tooltip } from '../tooltips';
+type PayeeMenuProps = {
+ payeesById: Record<PayeeEntity['id'], PayeeEntity>;
+ selectedPayees: Set<PayeeEntity['id']>;
+ onDelete: () => void;
+ onMerge: () => Promise<void>;
+ onClose: () => void;
+};
+
export default function PayeeMenu({
payeesById,
selectedPayees,
onDelete,
onMerge,
onClose,
-}) {
+}: PayeeMenuProps) {
// Transfer accounts are never editable
let isDisabled = [...selectedPayees].some(
id => payeesById[id] == null || payeesById[id].transfer_acct,
diff --git a/packages/desktop-client/src/components/payees/PayeeTable.js b/packages/desktop-client/src/components/payees/PayeeTable.tsx
similarity index 54%
rename from packages/desktop-client/src/components/payees/PayeeTable.js
rename to packages/desktop-client/src/components/payees/PayeeTable.tsx
index e5d9ad27d1..6a25680c90 100644
--- a/packages/desktop-client/src/components/payees/PayeeTable.js
+++ b/packages/desktop-client/src/components/payees/PayeeTable.tsx
@@ -1,32 +1,49 @@
-import { forwardRef, useState, useLayoutEffect, useCallback } from 'react';
+import {
+ forwardRef,
+ useCallback,
+ useLayoutEffect,
+ useState,
+ type ComponentProps,
+ type ComponentRef,
+} from 'react';
+
+import { type PayeeEntity } from 'loot-core/src/types/models';
import { useSelectedItems } from '../../hooks/useSelected';
import View from '../common/View';
-import { Table } from '../table';
+import { Table, type TableNavigator } from '../table';
import PayeeTableRow from './PayeeTableRow';
-const PayeeTable = forwardRef(
+// Table items require an ID to work, it's optional in the loot-core
+// model so would need to verify accuracy of that before changing there
+type PayeeWithId = PayeeEntity & Required<Pick<PayeeEntity, 'id'>>;
+
+type PayeeTableProps = {
+ payees: PayeeWithId[];
+ ruleCounts: Map<PayeeWithId['id'], number>;
+ navigator: TableNavigator<PayeeWithId>;
+} & Pick<
+ ComponentProps<typeof PayeeTableRow>,
+ 'onUpdate' | 'onViewRules' | 'onCreateRule'
+>;
+
+const PayeeTable = forwardRef<
+ ComponentRef<typeof Table<PayeeWithId>>,
+ PayeeTableProps
+>(
(
- {
- payees,
- ruleCounts,
- navigator,
- categoryGroups,
- highlightedRows,
- ruleActions,
- onUpdate,
- onViewRules,
- onCreateRule,
- },
+ { payees, ruleCounts, navigator, onUpdate, onViewRules, onCreateRule },
ref,
) => {
let [hovered, setHovered] = useState(null);
let selectedItems = useSelectedItems();
useLayoutEffect(() => {
- let firstSelected = [...selectedItems][0];
- ref.current.scrollTo(firstSelected, 'center');
+ let firstSelected = [...selectedItems][0] as string;
+ if (typeof ref !== 'function') {
+ ref.current.scrollTo(firstSelected, 'center');
+ }
navigator.onEdit(firstSelected, 'select');
}, []);
@@ -36,7 +53,7 @@ const PayeeTable = forwardRef(
return (
<View style={{ flex: 1 }} onMouseLeave={() => setHovered(null)}>
- <Table
+ <Table<PayeeWithId>
ref={ref}
items={payees}
navigator={navigator}
@@ -45,9 +62,7 @@ const PayeeTable = forwardRef(
<PayeeTableRow
payee={item}
ruleCount={ruleCounts.get(item.id) || 0}
- categoryGroups={categoryGroups}
selected={selectedItems.has(item.id)}
- highlighted={highlightedRows && highlightedRows.has(item.id)}
editing={editing}
focusedField={focusedField}
hovered={hovered === item.id}
diff --git a/packages/desktop-client/src/components/payees/PayeeTableRow.js b/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
similarity index 77%
rename from packages/desktop-client/src/components/payees/PayeeTableRow.js
rename to packages/desktop-client/src/components/payees/PayeeTableRow.tsx
index 8be52b3ba9..3875c84777 100644
--- a/packages/desktop-client/src/components/payees/PayeeTableRow.js
+++ b/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
@@ -1,12 +1,21 @@
import { memo } from 'react';
+import { type PayeeEntity } from 'loot-core/src/types/models';
+
import { useSelectedDispatch } from '../../hooks/useSelected';
import ArrowThinRight from '../../icons/v1/ArrowThinRight';
-import { theme } from '../../style';
+import { type CSSProperties, theme } from '../../style';
import Text from '../common/Text';
-import { Row, Cell, InputCell, SelectCell, CellButton } from '../table';
+import { Cell, CellButton, InputCell, Row, SelectCell } from '../table';
+
+type RuleButtonProps = {
+ ruleCount: number;
+ focused: boolean;
+ onEdit: () => void;
+ onClick: () => void;
+};
-function RuleButton({ ruleCount, focused, onEdit, onClick }) {
+function RuleButton({ ruleCount, focused, onEdit, onClick }: RuleButtonProps) {
return (
<Cell
name="rule-count"
@@ -26,7 +35,6 @@ function RuleButton({ ruleCount, focused, onEdit, onClick }) {
}}
onEdit={onEdit}
onSelect={onClick}
- onFocus={onEdit}
>
<Text style={{ paddingRight: 5 }}>
{ruleCount > 0 ? (
@@ -43,9 +51,29 @@ function RuleButton({ ruleCount, focused, onEdit, onClick }) {
);
}
+type EditablePayeeFields = keyof Pick<PayeeEntity, 'name'>;
+
+type PayeeTableRowProps = {
+ payee: PayeeEntity;
+ ruleCount: number;
+ selected: boolean;
+ hovered: boolean;
+ editing: boolean;
+ focusedField: string;
+ onHover?: (id: PayeeEntity['id']) => void;
+ onEdit: (id: PayeeEntity['id'], field: string) => void;
+ onUpdate: (
+ id: PayeeEntity['id'],
+ field: EditablePayeeFields,
+ value: unknown,
+ ) => void;
+ onViewRules: (id: PayeeEntity['id']) => void;
+ onCreateRule: (id: PayeeEntity['id']) => void;
+ style?: CSSProperties;
+};
+
const PayeeTableRow = memo(
({
- style,
payee,
ruleCount,
selected,
@@ -57,7 +85,8 @@ const PayeeTableRow = memo(
onHover,
onEdit,
onUpdate,
- }) => {
+ style,
+ }: PayeeTableRowProps) => {
let { id } = payee;
let dispatchSelected = useSelectedDispatch();
let borderColor = selected ? theme.tableBorderSelected : theme.tableBorder;
diff --git a/packages/desktop-client/src/components/table.tsx b/packages/desktop-client/src/components/table.tsx
index 4869694aae..eab24ad3d4 100644
--- a/packages/desktop-client/src/components/table.tsx
+++ b/packages/desktop-client/src/components/table.tsx
@@ -359,7 +359,7 @@ function InputValue({
type InputCellProps = ComponentProps<typeof Cell> & {
inputProps: ComponentProps<typeof InputValue>;
onUpdate: ComponentProps<typeof InputValue>['onUpdate'];
- onBlur: ComponentProps<typeof InputValue>['onBlur'];
+ onBlur?: ComponentProps<typeof InputValue>['onBlur'];
textAlign?: CSSProperties['textAlign'];
error?: ReactNode;
};
@@ -833,12 +833,12 @@ let rowStyle: CSSProperties = {
width: '100%',
};
-type TableHandleRef = {
- scrollTo: (id: number, alignment?: string) => void;
+type TableHandleRef<T extends TableItem = TableItem> = {
+ scrollTo: (id: T['id'], alignment?: string) => void;
scrollToTop: () => void;
- getScrolledItem: () => TableItem['id'];
+ getScrolledItem: () => T['id'];
setRowAnimation: (flag) => void;
- edit(id: number, field, shouldScroll): void;
+ edit(id: number, field: string, shouldScroll: boolean): void;
anchor(): void;
unanchor(): void;
isAnchored(): boolean;
@@ -848,7 +848,7 @@ type TableWithNavigatorProps = TableProps & {
fields;
};
export const TableWithNavigator = forwardRef<
- TableHandleRef,
+ TableHandleRef<TableItem>,
TableWithNavigatorProps
>(({ fields, ...props }, ref) => {
let navigator = useTableNavigator(props.items, fields);
@@ -857,7 +857,7 @@ export const TableWithNavigator = forwardRef<
type TableItem = { id: number | string };
-type TableProps<T = TableItem> = {
+type TableProps<T extends TableItem = TableItem> = {
items: T[];
count?: number;
headers?: ReactNode | TableHeaderProps['headers'];
@@ -868,8 +868,8 @@ type TableProps<T = TableItem> = {
renderItem: (arg: {
item: T;
editing: boolean;
- focusedField: unknown;
- onEdit: (id, field) => void;
+ focusedField: string | null;
+ onEdit: (id: T['id'], field: string) => void;
index: number;
position: number;
}) => ReactNode;
@@ -877,7 +877,7 @@ type TableProps<T = TableItem> = {
getItemKey?: (index: number) => TableItem['id'];
loadMore?: () => void;
style?: CSSProperties;
- navigator?: ReturnType<typeof useTableNavigator>;
+ navigator?: ReturnType<typeof useTableNavigator<T>>;
listRef?: unknown;
onScroll?: () => void;
version?: string;
@@ -887,7 +887,7 @@ type TableProps<T = TableItem> = {
};
export const Table: <T extends TableItem>(
- props: TableProps<T> & { ref?: Ref<TableHandleRef> },
+ props: TableProps<T> & { ref?: Ref<TableHandleRef<T>> },
) => ReactElement = forwardRef<TableHandleRef, TableProps>(
(
{
@@ -1096,7 +1096,7 @@ export const Table: <T extends TableItem>(
outline: 'none',
...style,
}}
- tabIndex="1"
+ tabIndex={1}
{...getNavigatorProps(props)}
data-testid="table"
>
@@ -1163,10 +1163,20 @@ export const Table: <T extends TableItem>(
},
);
-export function useTableNavigator(data, fields) {
+export type TableNavigator<T extends TableItem> = {
+ onEdit: (id: T['id'], field?: string) => void;
+ editingId: T['id'];
+ focusedField: string;
+ getNavigatorProps: (userProps: object) => object;
+};
+
+export function useTableNavigator<T extends TableItem>(
+ data: T[],
+ fields: string[] | ((item?: T) => string[]),
+): TableNavigator<T> {
let getFields = typeof fields !== 'function' ? () => fields : fields;
- let [editingId, setEditingId] = useState(null);
- let [focusedField, setFocusedField] = useState(null);
+ let [editingId, setEditingId] = useState<T['id']>(null);
+ let [focusedField, setFocusedField] = useState<string>(null);
let containerRef = useRef<HTMLDivElement>();
// See `onBlur` for why we need this
@@ -1174,7 +1184,7 @@ export function useTableNavigator(data, fields) {
let modalStackLength = useRef(0);
// onEdit is passed to children, so make sure it maintains identity
- let onEdit = useCallback((id, field?) => {
+ let onEdit = useCallback((id: T['id'], field?: string) => {
setEditingId(id);
setFocusedField(id ? field : null);
}, []);
diff --git a/upcoming-release-notes/1948.md b/upcoming-release-notes/1948.md
new file mode 100644
index 0000000000..b1bbafd500
--- /dev/null
+++ b/upcoming-release-notes/1948.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [kymckay]
+---
+
+Refactor Payee table to TypeScript and harden generic `Table` component typing.