Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Maintenance] Update CloseAccount, AccountAutocomplete, SavedFilterAutocomplete, PayeeAutocomplete components to Typescript. #1923

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, { type ComponentProps } from 'react';

import { css } from 'glamor';

Expand Down Expand Up @@ -108,13 +108,20 @@ function AccountList({
);
}

type AutoCompleteProps = {
embedded?: boolean;
includeClosedAccounts: boolean;
groupHeaderStyle?: boolean;
closeOnBlur?: boolean;
} & ComponentProps<typeof Autocomplete>;

export default function AccountAutocomplete({
embedded,
includeClosedAccounts = true,
groupHeaderStyle,
closeOnBlur,
...props
}) {
}: AutoCompleteProps) {
let accounts = useCachedAccounts() || [];

//remove closed accounts if needed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,9 @@ type SingleAutocompleteProps = {
embedded?: boolean;
containerProps?: HTMLProps<HTMLDivElement>;
labelProps?: { id?: string };
inputProps?: ComponentProps<typeof Input>;
inputProps?: Omit<ComponentProps<typeof Input>, 'onChange'> & {
onChange?: (value: string) => void;
};
suggestions?: unknown[];
tooltipStyle?: CSSProperties;
tooltipProps?: ComponentProps<typeof Tooltip>;
Expand All @@ -158,7 +160,7 @@ type SingleAutocompleteProps = {
idx: number,
value?: unknown,
) => ReactNode;
itemToString?: (item: unknown) => string;
itemToString?: (item) => string;
shouldSaveFromKey?: (e: KeyboardEvent) => boolean;
filterSuggestions?: (suggestions, value: string) => unknown[];
openOnFocus?: boolean;
Expand All @@ -169,7 +171,7 @@ type SingleAutocompleteProps = {
onSelect: (id: unknown, value: string) => void;
tableBehavior?: boolean;
closeOnBlur?: boolean;
value: unknown[];
value: unknown[] | string;
isMulti?: boolean;
};
function SingleAutocomplete({
Expand Down Expand Up @@ -482,7 +484,6 @@ function SingleAutocomplete({
},
onChange: (e: ChangeEvent<HTMLInputElement>) => {
const { onChange } = inputProps || {};
// @ts-expect-error unsure if onChange needs an event or a string
onChange?.(e.target.value);
},
}),
Expand Down Expand Up @@ -679,13 +680,25 @@ export function AutocompleteFooter({
);
}

type AutocompleteProps = ComponentProps<typeof SingleAutocomplete> & {
multi?: boolean;
};
export default function Autocomplete({ multi, ...props }: AutocompleteProps) {
type AutocompleteProps =
| ComponentProps<typeof SingleAutocomplete>
| ComponentProps<typeof MultiAutocomplete>;

export default function Autocomplete({
multi,
...props
}: AutocompleteProps & { multi?: boolean }) {
if (multi) {
return <MultiAutocomplete {...props} />;
return (
<MultiAutocomplete
{...(props as ComponentProps<typeof MultiAutocomplete>)}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💬 suggestion: ‏you could create a tiny typeguard util function. That would help get rid of this manual type coercion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added two typeguards and removed the "as" cast

/>
);
} else {
return <SingleAutocomplete {...props} />;
return (
<SingleAutocomplete
{...(props as ComponentProps<typeof SingleAutocomplete>)}
/>
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import React, {
Fragment,
useMemo,
type ReactNode,
type CSSProperties,
} from 'react';

import { css } from 'glamor';
Expand Down Expand Up @@ -151,8 +152,9 @@ function CategoryList({
type CategoryAutocompleteProps = ComponentProps<typeof Autocomplete> & {
categoryGroups: Array<CategoryGroupEntity>;
showSplitOption?: boolean;
groupHeaderStyle?: object;
groupHeaderStyle?: CSSProperties;
};

export default function CategoryAutocomplete({
categoryGroups,
showSplitOption,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
import React, { Fragment, useState, useMemo } from 'react';
import React, {
Fragment,
useState,
useMemo,
type ComponentProps,
type CSSProperties,
} from 'react';
import { useDispatch } from 'react-redux';

import { css } from 'glamor';
Expand All @@ -7,6 +13,10 @@ import { createPayee } from 'loot-core/src/client/actions/queries';
import { useCachedAccounts } from 'loot-core/src/client/data-hooks/accounts';
import { useCachedPayees } from 'loot-core/src/client/data-hooks/payees';
import { getActivePayees } from 'loot-core/src/client/reducers/queries';
import {
type AccountEntity,
type PayeeEntity,
} from 'loot-core/src/types/models';

import Add from '../../icons/v1/Add';
import { useResponsive } from '../../ResponsiveProvider';
Expand Down Expand Up @@ -202,6 +212,22 @@ function PayeeList({
);
}

type PayeeAutocompleteProps = {
value: ComponentProps<typeof Autocomplete>['value'];
inputProps: ComponentProps<typeof Autocomplete>['inputProps'];
showMakeTransfer?: boolean;
showManagePayees?: boolean;
tableBehavior: ComponentProps<typeof Autocomplete>['tableBehavior'];
embedded?: boolean;
closeOnBlur: ComponentProps<typeof Autocomplete>['closeOnBlur'];
onUpdate?: (value: string) => void;
onSelect?: (value: string) => void;
onManagePayees: () => void;
groupHeaderStyle: CSSProperties;
accounts?: AccountEntity[];
payees?: PayeeEntity[];
};

export default function PayeeAutocomplete({
value,
inputProps,
Expand All @@ -217,7 +243,7 @@ export default function PayeeAutocomplete({
accounts,
payees,
...props
}) {
}: PayeeAutocompleteProps) {
let cachedPayees = useCachedPayees();
if (!payees) {
payees = cachedPayees;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, { type ComponentProps } from 'react';

import { useFilters } from 'loot-core/src/client/data-hooks/filters';

Expand All @@ -7,7 +7,19 @@ import View from '../common/View';

import Autocomplete from './Autocomplete';

function FilterList({ items, getItemProps, highlightedIndex, embedded }) {
type FilterListProps = {
items: { id: string; name: string }[];
getItemProps: (arg: { item: unknown }) => ComponentProps<typeof View>;
highlightedIndex: number;
embedded?: boolean;
};

function FilterList({
items,
getItemProps,
highlightedIndex,
embedded,
}: FilterListProps) {
return (
<View>
<View
Expand Down Expand Up @@ -44,7 +56,14 @@ function FilterList({ items, getItemProps, highlightedIndex, embedded }) {
);
}

export default function SavedFilterAutocomplete({ embedded, ...props }) {
type SavedFilterAutocompleteProps = {
embedded?: boolean;
} & ComponentProps<typeof Autocomplete>;

export default function SavedFilterAutocomplete({
embedded,
...props
}: SavedFilterAutocompleteProps) {
let filters = useFilters() || [];

return (
Expand Down
8 changes: 7 additions & 1 deletion packages/desktop-client/src/components/common/Button.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,13 @@ type ButtonProps = HTMLProps<HTMLButtonElement> & {
as?: ElementType;
};

type ButtonType = 'normal' | 'primary' | 'bare' | 'link';
type ButtonType =
| 'normal'
| 'primary'
| 'bare'
| 'link'
| 'menu'
| 'menuSelected';

const backgroundColor = {
normal: theme.buttonNormalBackground,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
import React, { useState } from 'react';

import { integerToCurrency } from 'loot-core/src/shared/util';
import {
type AccountEntity,
type CategoryGroupEntity,
} from 'loot-core/src/types/models';

import { type BoundActions } from '../../hooks/useActions';
import { theme } from '../../style';
import { type CommonModalProps } from '../../types/modals';
import AccountAutocomplete from '../autocomplete/AccountAutocomplete';
import CategoryAutocomplete from '../autocomplete/CategoryAutocomplete';
import Button from '../common/Button';
Expand All @@ -13,7 +19,11 @@ import Paragraph from '../common/Paragraph';
import Text from '../common/Text';
import View from '../common/View';

function needsCategory(account, currentTransfer, accounts) {
function needsCategory(
account: AccountEntity,
currentTransfer: string,
accounts: AccountEntity[],
) {
const acct = accounts.find(a => a.id === currentTransfer);
const isOffBudget = acct && acct.offbudget === 1;

Expand All @@ -22,6 +32,16 @@ function needsCategory(account, currentTransfer, accounts) {
return account.offbudget === 0 && isOffBudget;
}

type CloseAccountProps = {
account: AccountEntity;
accounts: AccountEntity[];
categoryGroups: CategoryGroupEntity[];
balance: number;
canDelete: boolean;
actions: BoundActions;
modalProps: CommonModalProps;
};

function CloseAccount({
account,
accounts,
Expand All @@ -30,7 +50,7 @@ function CloseAccount({
canDelete,
actions,
modalProps,
}) {
}: CloseAccountProps) {
let [loading, setLoading] = useState(false);
let [transfer, setTransfer] = useState('');
let [category, setCategory] = useState('');
Expand Down Expand Up @@ -95,7 +115,6 @@ function CloseAccount({
<AccountAutocomplete
includeClosedAccounts={false}
value={transfer}
accounts={accounts}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unused

inputProps={{
placeholder: 'Select account...',
}}
Expand Down
7 changes: 6 additions & 1 deletion packages/loot-core/src/client/actions/queries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,12 @@ export function openAccountCloseModal(accountId) {
};
}

export function closeAccount(accountId, transferAccountId, categoryId, forced) {
export function closeAccount(
accountId: string,
transferAccountId: string,
categoryId: string,
forced?: boolean,
) {
return async (dispatch: Dispatch) => {
await send('account-close', {
id: accountId,
Expand Down
6 changes: 6 additions & 0 deletions upcoming-release-notes/1923.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
category: Maintenance
authors: [MikesGlitch]
---

Convert CloseAccount, AccountAutocomplete, SavedFilterAutocomplete, PayeeAutocomplete components to Typescript.