A local-first personal finance app
:recycle: (typescript) migrate parts of ImportTransactionModal to TS (#3570)
Matiss Janis Aboltins23de23bd4e62
diff --git a/packages/desktop-client/src/components/forms.tsx b/packages/desktop-client/src/components/forms.tsxindex a756aba2a9..96a11633b7 100644--- a/packages/desktop-client/src/components/forms.tsx+++ b/packages/desktop-client/src/components/forms.tsx@@ -64,7 +64,9 @@ export const FormField = ({ style, children }: FormFieldProps) => {// Custom inputs-type CheckboxProps = ComponentProps<'input'>;+type CheckboxProps = ComponentProps<'input'> & {+ style?: CSSProperties;+};export const Checkbox = (props: CheckboxProps) => {return (diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/CheckboxOption.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/CheckboxOption.tsxsimilarity index 57%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/CheckboxOption.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/CheckboxOption.tsxindex 76e1e7fb91..b7c74901a2 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/CheckboxOption.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/CheckboxOption.tsx@@ -1,9 +1,18 @@-import React from 'react';+import React, { type ComponentProps, type ReactNode } from 'react';-import { theme } from '../../../style';+import { type CSSProperties, theme } from '../../../style';import { View } from '../../common/View';import { Checkbox } from '../../forms';+type CheckboxOptionProps = {+ id: string;+ checked?: ComponentProps<typeof Checkbox>['checked'];+ disabled?: ComponentProps<typeof Checkbox>['disabled'];+ onChange?: ComponentProps<typeof Checkbox>['onChange'];+ children: ReactNode;+ style?: CSSProperties;+};+export function CheckboxOption({id,checked,@@ -11,7 +20,7 @@ export function CheckboxOption({onChange,children,style,-}) {+}: CheckboxOptionProps) {return (<Viewstyle={{@@ -33,7 +42,7 @@ export function CheckboxOption({htmlFor={id}style={{userSelect: 'none',- color: disabled ? theme.pageTextSubdued : null,+ color: disabled ? theme.pageTextSubdued : undefined,}}>{children}diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/DateFormatSelect.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/DateFormatSelect.tsxsimilarity index 78%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/DateFormatSelect.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/DateFormatSelect.tsxindex c911ea36c6..d743c71ded 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/DateFormatSelect.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/DateFormatSelect.tsx@@ -4,14 +4,25 @@ import { Select } from '../../common/Select';import { View } from '../../common/View';import { SectionLabel } from '../../forms';-import { dateFormats } from './utils';+import {+ dateFormats,+ type ImportTransaction,+ type FieldMapping,+} from './utils';++type DateFormatSelectProps = {+ transactions: ImportTransaction[];+ fieldMappings: FieldMapping;+ parseDateFormat?: string;+ onChange: (newValue: string) => void;+};export function DateFormatSelect({transactions,fieldMappings,parseDateFormat,onChange,-}) {+}: DateFormatSelectProps) {// We don't actually care about the delimiter, but we try to render// it based on the data we have so far. Look in a transaction and// try to figure out what delimiter the date is using, and defaultdiff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/FieldMappings.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/FieldMappings.tsxsimilarity index 87%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/FieldMappings.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/FieldMappings.tsxindex b57e651dce..e4a0ab4e80 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/FieldMappings.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/FieldMappings.tsx@@ -6,23 +6,44 @@ import { SectionLabel } from '../../forms';import { SelectField } from './SelectField';import { SubLabel } from './SubLabel';-import { stripCsvImportTransaction } from './utils';+import {+ stripCsvImportTransaction,+ type FieldMapping,+ type ImportTransaction,+} from './utils';++type FieldMappingsProps = {+ transactions: ImportTransaction[];+ mappings?: FieldMapping;+ onChange: (field: keyof FieldMapping, newValue: string) => void;+ splitMode: boolean;+ inOutMode: boolean;+ hasHeaderRow: boolean;+};export function FieldMappings({transactions,- mappings,+ mappings = {+ date: null,+ amount: null,+ payee: null,+ notes: null,+ inOut: null,+ category: null,+ outflow: null,+ inflow: null,+ },onChange,splitMode,inOutMode,hasHeaderRow,-}) {+}: FieldMappingsProps) {if (transactions.length === 0) {return null;}const trans = stripCsvImportTransaction(transactions[0]);const options = Object.keys(trans);- mappings = mappings || {};return (<View>diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/InOutOption.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/InOutOption.tsxsimilarity index 81%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/InOutOption.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/InOutOption.tsxindex 5bd36a8f42..80b565789a 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/InOutOption.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/InOutOption.tsx@@ -5,13 +5,21 @@ import { View } from '../../common/View';import { CheckboxOption } from './CheckboxOption';+type InOutOptionProps = {+ inOutMode: boolean;+ outValue: string;+ disabled: boolean;+ onToggle: () => void;+ onChangeText: (newValue: string) => void;+};+export function InOutOption({inOutMode,outValue,disabled,onToggle,onChangeText,-}) {+}: InOutOptionProps) {return (<View style={{ flexDirection: 'row', gap: 10, height: 28 }}><CheckboxOptiondiff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/MultiplierOption.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/MultiplierOption.tsxsimilarity index 71%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/MultiplierOption.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/MultiplierOption.tsxindex f5d922cf51..4eb4fd23dc 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/MultiplierOption.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/MultiplierOption.tsx@@ -1,16 +1,23 @@-import React from 'react';+import React, { type ComponentProps } from 'react';import { Input } from '../../common/Input';import { View } from '../../common/View';import { CheckboxOption } from './CheckboxOption';+type MultiplierOptionProps = {+ multiplierEnabled: boolean;+ multiplierAmount: string;+ onToggle: ComponentProps<typeof CheckboxOption>['onChange'];+ onChangeAmount: (newValue: string) => void;+};+export function MultiplierOption({multiplierEnabled,multiplierAmount,onToggle,onChangeAmount,-}) {+}: MultiplierOptionProps) {return (<View style={{ flexDirection: 'row', gap: 10, height: 28 }}><CheckboxOptiondiff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/ParsedDate.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/ParsedDate.tsxsimilarity index 73%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/ParsedDate.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/ParsedDate.tsxindex 9abf5e340c..81ca7c93ba 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/ParsedDate.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/ParsedDate.tsx@@ -5,7 +5,17 @@ import { Text } from '../../common/Text';import { formatDate, parseDate } from './utils';-export function ParsedDate({ parseDateFormat, dateFormat, date }) {+type ParsedDateProps = {+ parseDateFormat?: Parameters<typeof parseDate>[1];+ dateFormat: Parameters<typeof parseDate>[1];+ date?: string;+};++export function ParsedDate({+ parseDateFormat,+ dateFormat,+ date,+}: ParsedDateProps) {const parsed =date &&formatDate(diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/SelectField.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/SelectField.jsxdeleted file mode 100644index 0626b8e639..0000000000--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/SelectField.jsx+++ /dev/null@@ -1,29 +0,0 @@-import React from 'react';--import { Select } from '../../common/Select';--export function SelectField({- style,- options,- value,- onChange,- hasHeaderRow,- firstTransaction,-}) {- return (- <Select- options={[- ['choose-field', 'Choose field...'],- ...options.map(option => [- option,- hasHeaderRow- ? option- : `Column ${parseInt(option) + 1} (${firstTransaction[option]})`,- ]),- ]}- value={value === null ? 'choose-field' : value}- onChange={onChange}- style={style}- />- );-}diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/SelectField.tsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/SelectField.tsxnew file mode 100644index 0000000000..5e28d2a087--- /dev/null+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/SelectField.tsx@@ -0,0 +1,42 @@+import React from 'react';++import { type CSSProperties } from '../../../style';+import { Select } from '../../common/Select';++type SelectFieldProps = {+ style?: CSSProperties;+ options: string[];+ value: null | string;+ onChange: (newValue: string) => void;+ hasHeaderRow: boolean;+ firstTransaction: Record<string, unknown>;+};++export function SelectField({+ style,+ options,+ value,+ onChange,+ hasHeaderRow,+ firstTransaction,+}: SelectFieldProps) {+ return (+ <Select+ options={[+ ['choose-field', 'Choose field...'],+ ...options.map(+ option =>+ [+ option,+ hasHeaderRow+ ? option+ : `Column ${parseInt(option) + 1} (${firstTransaction[option]})`,+ ] as const,+ ),+ ]}+ value={value === null ? 'choose-field' : value}+ onChange={onChange}+ style={style}+ />+ );+}diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/SubLabel.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/SubLabel.tsxsimilarity index 70%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/SubLabel.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/SubLabel.tsxindex 0d1d64de24..7994c94fcf 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/SubLabel.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/SubLabel.tsx@@ -3,7 +3,11 @@ import React from 'react';import { theme } from '../../../style';import { Text } from '../../common/Text';-export function SubLabel({ title }) {+type SubLabelProps = {+ title: string;+};++export function SubLabel({ title }: SubLabelProps) {return (<Text style={{ fontSize: 13, marginBottom: 3, color: theme.pageText }}>{title}diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/Transaction.jsx b/packages/desktop-client/src/components/modals/ImportTransactionsModal/Transaction.tsxsimilarity index 85%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/Transaction.jsxrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/Transaction.tsxindex 0a861eb02a..14e456fc1a 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/Transaction.jsx+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/Transaction.tsx@@ -1,6 +1,7 @@-import React, { useMemo } from 'react';+import React, { type ComponentProps, useMemo } from 'react';import { amountToCurrency } from 'loot-core/src/shared/util';+import { type CategoryEntity } from 'loot-core/types/models';import { SvgDownAndRightArrow } from '../../../icons/v2';import { theme, styles } from '../../../style';@@ -11,7 +12,29 @@ import { Checkbox } from '../../forms';import { Row, Field } from '../../table';import { ParsedDate } from './ParsedDate';-import { applyFieldMappings, formatDate, parseAmountFields } from './utils';+import {+ applyFieldMappings,+ type FieldMapping,+ formatDate,+ type ImportTransaction,+ parseAmountFields,+} from './utils';++type TransactionProps = {+ transaction: ImportTransaction;+ fieldMappings: FieldMapping;+ showParsed: boolean;+ parseDateFormat: ComponentProps<typeof ParsedDate>['parseDateFormat'];+ dateFormat: ComponentProps<typeof ParsedDate>['dateFormat'];+ splitMode: boolean;+ inOutMode: boolean;+ outValue: number;+ flipAmount: boolean;+ multiplierAmount: string;+ categories: CategoryEntity[];+ onCheckTransaction: (transactionId: string) => void;+ reconcile: boolean;+};export function Transaction({transaction: rawTransaction,@@ -27,7 +50,7 @@ export function Transaction({categories,onCheckTransaction,reconcile,-}) {+}: TransactionProps) {const categoryList = categories.map(category => category.name);const transaction = useMemo(() =>@@ -37,23 +60,34 @@ export function Transaction({[rawTransaction, fieldMappings],);- let amount, outflow, inflow;- if (rawTransaction.isMatchedTransaction) {- amount = rawTransaction.amount;- if (splitMode) {- outflow = amount < 0 ? -amount : 0;- inflow = amount > 0 ? amount : 0;+ const { amount, outflow, inflow } = useMemo(() => {+ if (rawTransaction.isMatchedTransaction) {+ const amount = rawTransaction.amount;++ return {+ amount,+ outflow: splitMode ? (amount < 0 ? -amount : 0) : null,+ inflow: splitMode ? (amount > 0 ? amount : 0) : null,+ };}- } else {- ({ amount, outflow, inflow } = parseAmountFields(++ return parseAmountFields(transaction,splitMode,inOutMode,outValue,flipAmount,multiplierAmount,- ));- }+ );+ }, [+ rawTransaction,+ transaction,+ splitMode,+ inOutMode,+ outValue,+ flipAmount,+ multiplierAmount,+ ]);return (<Row@@ -214,7 +248,11 @@ export function Transaction({<Fieldwidth={90}contentStyle={{ textAlign: 'left', ...styles.tnum }}- title={transaction.inOut}+ title={+ transaction.inOut === undefined+ ? undefined+ : String(transaction.inOut)+ }>{transaction.inOut}</Field>diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.test.js b/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.test.tssimilarity index 93%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.test.jsrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.test.tsindex f4bfa6841c..e6da6eba91 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.test.js+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.test.ts@@ -1,8 +1,11 @@import { parseDate } from './utils';-describe('Import transactions', function () {- describe('date parsing', function () {- const invalidInputs = [+describe('Import transactions', () => {+ describe('date parsing', () => {+ const invalidInputs: Array<{+ str: Parameters<typeof parseDate>[0];+ order: Parameters<typeof parseDate>[1];+ }> = [{ str: '', order: 'yyyy mm dd' },{ str: null, order: 'yyyy mm dd' },{ str: 42, order: 'yyyy mm dd' },@@ -37,7 +40,10 @@ describe('Import transactions', function () {},);- const validInputs = [+ const validInputs: Array<{+ order: Parameters<typeof parseDate>[1];+ cases: [Parameters<typeof parseDate>[0], ReturnType<typeof parseDate>][];+ }> = [{order: 'yyyy mm dd',cases: [diff --git a/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.js b/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.tssimilarity index 72%rename from packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.jsrename to packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.tsindex da881f10bb..7b057c7d82 100644--- a/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.js+++ b/packages/desktop-client/src/components/modals/ImportTransactionsModal/utils.ts@@ -10,18 +10,27 @@ export const dateFormats = [{ format: 'mm dd yy', label: 'MM DD YY' },{ format: 'dd mm yyyy', label: 'DD MM YYYY' },{ format: 'dd mm yy', label: 'DD MM YY' },-];--export function parseDate(str, order) {+] as const;++export function parseDate(+ str: string | number | null | Array<unknown> | object,+ order:+ | 'yyyy mm dd'+ | 'yy mm dd'+ | 'mm dd yyyy'+ | 'mm dd yy'+ | 'dd mm yyyy'+ | 'dd mm yy',+) {if (typeof str !== 'string') {return null;}- function pad(v) {+ function pad(v: string) {return v && v.length === 1 ? '0' + v : v;}- const dateGroups = (a, b) => str => {+ const dateGroups = (a: number, b: number) => (str: string) => {const parts = str.replace(/\bjan(\.|uary)?\b/i, '01').replace(/\bfeb(\.|ruary)?\b/i, '02')@@ -48,7 +57,7 @@ export function parseDate(str, order) {const yearFirst = dateGroups(4, 2);const twoDig = dateGroups(2, 2);- let parts, year, month, day;+ let parts: string[], year: string, month: string, day: string;switch (order) {case 'dd mm yyyy':parts = twoDig(str);@@ -95,7 +104,10 @@ export function parseDate(str, order) {return parsed;}-export function formatDate(date, format) {+export function formatDate(+ date: Parameters<typeof formatDate_>[0] | null,+ format: Parameters<typeof formatDate_>[1],+) {if (!date) {return null;}@@ -105,14 +117,36 @@ export function formatDate(date, format) {return null;}-export function applyFieldMappings(transaction, mappings) {- const result = {};+export type ImportTransaction = {+ trx_id: string;+ existing: boolean;+ ignored: boolean;+ selected: boolean;+ selected_merge: boolean;+ amount: number;+ inflow: number;+ outflow: number;+ inOut: number;+} & Record<string, string>;++export type FieldMapping = {+ date: string | null;+ amount: string | null;+ payee: string | null;+ notes: string | null;+ inOut: string | null;+ category: string | null;+ outflow: string | null;+ inflow: string | null;+};++export function applyFieldMappings(+ transaction: ImportTransaction,+ mappings: FieldMapping,+) {+ const result: Partial<ImportTransaction> = {};for (const [originalField, target] of Object.entries(mappings)) {- let field = originalField;- if (field === 'payee') {- field = 'payee_name';- }-+ const field = originalField === 'payee' ? 'payee_name' : originalField;result[field] = transaction[target || field];}// Keep preview fields on the mapped transactions@@ -121,10 +155,14 @@ export function applyFieldMappings(transaction, mappings) {result.ignored = transaction.ignored;result.selected = transaction.selected;result.selected_merge = transaction.selected_merge;- return result;+ return result as ImportTransaction;}-function parseAmount(amount, mapper, multiplier) {+function parseAmount(+ amount: number | string | undefined | null,+ mapper: (parsed: number) => number,+ multiplier: number,+) {if (amount == null) {return null;}@@ -140,12 +178,12 @@ function parseAmount(amount, mapper, multiplier) {}export function parseAmountFields(- trans,- splitMode,- inOutMode,- outValue,- flipAmount,- multiplierAmount,+ trans: Partial<ImportTransaction>,+ splitMode: boolean,+ inOutMode: boolean,+ outValue: number,+ flipAmount: boolean,+ multiplierAmount: string,) {const multiplier = parseFloat(multiplierAmount) || 1.0;@@ -186,7 +224,7 @@ export function parseAmountFields(};}-export function stripCsvImportTransaction(transaction) {+export function stripCsvImportTransaction(transaction: ImportTransaction) {const { existing, ignored, selected, selected_merge, trx_id, ...trans } =transaction;diff --git a/upcoming-release-notes/3570.md b/upcoming-release-notes/3570.mdnew file mode 100644index 0000000000..1d62319d47--- /dev/null+++ b/upcoming-release-notes/3570.md@@ -0,0 +1,6 @@+---+category: Maintenance+authors: [MatissJanis]+---++TypeScript: migrate smaller ImportTransactionsModal components to TS.diff --git a/upcoming-release-notes/3603.md b/upcoming-release-notes/3603.mdindex 4df7d55549..90920fca87 100644--- a/upcoming-release-notes/3603.md+++ b/upcoming-release-notes/3603.md@@ -3,4 +3,4 @@ category: Bugfixauthors: [wysinder]----Fixes inaccurate running balance when hiding reconciled transactions\ No newline at end of file+Fixes inaccurate running balance when hiding reconciled transactions