Merge pull request #34655 from ruben-rebelo/ts-migration/searchPage

[TS migration] Migrate SearchPage
Expensify · Mar 11, 2024 · f4c7378 · f4c7378
2 parents 95a774e + bef7c71
commit f4c7378
Show file tree

Hide file tree

Showing 12 changed files with 62 additions and 59 deletions.
diff --git a/src/components/DatePicker/CalendarPicker/YearPickerModal.tsx b/src/components/DatePicker/CalendarPicker/YearPickerModal.tsx
@@ -31,7 +31,7 @@ function YearPickerModal({isVisible, years, currentYear = new Date().getFullYear
     const {translate} = useLocalize();
     const [searchText, setSearchText] = useState('');
     const {sections, headerMessage} = useMemo(() => {
-        const yearsList = searchText === '' ? years : years.filter((year) => year.text.includes(searchText));
+        const yearsList = searchText === '' ? years : years.filter((year) => year.text?.includes(searchText));
         return {
             headerMessage: !yearsList.length ? translate('common.noResultsFound') : '',
             sections: [{data: yearsList.sort((a, b) => b.value - a.value), indexOffset: 0}],

diff --git a/src/components/SelectionList/BaseListItem.tsx b/src/components/SelectionList/BaseListItem.tsx
@@ -66,19 +66,19 @@ function BaseListItem<TItem extends ListItem>({
                 {...bind}
                 onPress={() => onSelectRow(item)}
                 disabled={isDisabled}
-                accessibilityLabel={item.text}
+                accessibilityLabel={item.text ?? ''}
                 role={CONST.ROLE.BUTTON}
                 hoverDimmingValue={1}
                 hoverStyle={!item.isSelected && styles.hoveredComponentBG}
                 dataSet={{[CONST.SELECTION_SCRAPER_HIDDEN_ELEMENT]: true}}
                 onMouseDown={shouldPreventDefaultFocusOnSelectRow ? (e) => e.preventDefault() : undefined}
-                nativeID={keyForList}
+                nativeID={keyForList ?? ''}
                 style={pressableStyle}
             >
                 <View style={wrapperStyle}>
                     {canSelectMultiple && (
                         <PressableWithFeedback
-                            accessibilityLabel={item.text}
+                            accessibilityLabel={item.text ?? ''}
                             role={CONST.ROLE.BUTTON}
                             disabled={isDisabled}
                             onPress={handleCheckboxPress}

diff --git a/src/components/SelectionList/BaseSelectionList.tsx b/src/components/SelectionList/BaseSelectionList.tsx
@@ -294,7 +294,7 @@ function BaseSelectionList<TItem extends ListItem>(
                 onDismissError={() => onDismissError?.(item)}
                 shouldPreventDefaultFocusOnSelectRow={shouldPreventDefaultFocusOnSelectRow}
                 rightHandSideComponent={rightHandSideComponent}
-                keyForList={item.keyForList}
+                keyForList={item.keyForList ?? ''}
                 isMultilineSupported={isRowMultilineSupported}
             />
         );
@@ -457,7 +457,7 @@ function BaseSelectionList<TItem extends ListItem>(
                                     getItemLayout={getItemLayout}
                                     onScroll={onScroll}
                                     onScrollBeginDrag={onScrollBeginDrag}
-                                    keyExtractor={(item) => item.keyForList}
+                                    keyExtractor={(item, index) => item.keyForList ?? `${index}`}
                                     extraData={focusedIndex}
                                     indicatorStyle="white"
                                     keyboardShouldPersistTaps="always"

diff --git a/src/components/SelectionList/RadioListItem.tsx b/src/components/SelectionList/RadioListItem.tsx
@@ -42,7 +42,7 @@ function RadioListItem({
                 <View style={[styles.flex1, styles.alignItemsStart]}>
                     <TextWithTooltip
                         shouldShowTooltip={showTooltip}
-                        text={item.text}
+                        text={item.text ?? ''}
                         style={[
                             styles.optionDisplayName,
                             isFocused ? styles.sidebarLinkActiveText : styles.sidebarLinkText,

diff --git a/src/components/SelectionList/TableListItem.tsx b/src/components/SelectionList/TableListItem.tsx
@@ -62,7 +62,7 @@ function TableListItem({
                     <View style={[styles.flex1, styles.flexColumn, styles.justifyContentCenter, styles.alignItemsStretch]}>
                         <TextWithTooltip
                             shouldShowTooltip={showTooltip}
-                            text={item.text}
+                            text={item.text ?? ''}
                             style={[
                                 styles.optionDisplayName,
                                 isFocused ? styles.sidebarLinkActiveText : styles.sidebarLinkText,

diff --git a/src/components/SelectionList/UserListItem.tsx b/src/components/SelectionList/UserListItem.tsx
@@ -57,7 +57,7 @@ function UserListItem({
             }
             keyForList={item.keyForList}
         >
-            {(hovered) => (
+            {(hovered?: boolean) => (
                 <>
                     {!!item.icons &&
                         (item.shouldShowSubscript ? (
@@ -81,7 +81,7 @@ function UserListItem({
                     <View style={[styles.flex1, styles.flexColumn, styles.justifyContentCenter, styles.alignItemsStretch, styles.optionRow]}>
                         <TextWithTooltip
                             shouldShowTooltip={showTooltip}
-                            text={item.text}
+                            text={item.text ?? ''}
                             style={[
                                 styles.optionDisplayName,
                                 isFocused ? styles.sidebarLinkActiveText : styles.sidebarLinkText,

diff --git a/src/components/SelectionList/types.ts b/src/components/SelectionList/types.ts
@@ -1,5 +1,7 @@
 import type {ReactElement, ReactNode} from 'react';
 import type {GestureResponderEvent, InputModeOptions, LayoutChangeEvent, SectionListData, StyleProp, TextStyle, ViewStyle} from 'react-native';
+import type {MaybePhraseKey} from '@libs/Localize';
+import type CONST from '@src/CONST';
 import type {Errors, Icon, PendingAction} from '@src/types/onyx/OnyxCommon';
 import type {ReceiptErrors} from '@src/types/onyx/Transaction';
 import type ChildrenProps from '@src/types/utils/ChildrenProps';
@@ -12,7 +14,7 @@ type CommonListItemProps<TItem> = {
     isFocused?: boolean;
 
     /** Whether this item is disabled */
-    isDisabled?: boolean;
+    isDisabled?: boolean | null;
 
     /** Whether this item should show Tooltip */
     showTooltip: boolean;
@@ -47,19 +49,19 @@ type CommonListItemProps<TItem> = {
 
 type ListItem = {
     /** Text to display */
-    text: string;
+    text?: string;
 
     /** Alternate text to display */
     alternateText?: string | null;
 
     /** Key used internally by React */
-    keyForList: string;
+    keyForList?: string | null;
 
     /** Whether this option is selected */
     isSelected?: boolean;
 
     /** Whether this option is disabled for selection */
-    isDisabled?: boolean;
+    isDisabled?: boolean | null;
 
     /** List title is bold by default. Use this props to customize it */
     isBold?: boolean;
@@ -90,6 +92,9 @@ type ListItem = {
     /** Represents the index of the option within the section it came from */
     index?: number;
 
+    /** ID of the report */
+    reportID?: string;
+
     /** Whether this option should show subscript */
     shouldShowSubscript?: boolean | null;
 
@@ -117,7 +122,7 @@ type ListItemProps = CommonListItemProps<ListItem> & {
 type BaseListItemProps<TItem extends ListItem> = CommonListItemProps<TItem> & {
     item: TItem;
     shouldPreventDefaultFocusOnSelectRow?: boolean;
-    keyForList?: string;
+    keyForList?: string | null;
     errors?: Errors | ReceiptErrors | null;
     pendingAction?: PendingAction | null;
     FooterComponent?: ReactElement;
@@ -158,7 +163,7 @@ type Section<TItem extends ListItem> = {
 
 type BaseSelectionListProps<TItem extends ListItem> = Partial<ChildrenProps> & {
     /** Sections for the section list */
-    sections: Array<SectionListData<TItem, Section<TItem>>>;
+    sections: Array<SectionListData<TItem, Section<TItem>>> | typeof CONST.EMPTY_ARRAY;
 
     /** Default renderer for every item in the list */
     ListItem: typeof RadioListItem | typeof UserListItem | typeof TableListItem;
@@ -185,7 +190,7 @@ type BaseSelectionListProps<TItem extends ListItem> = Partial<ChildrenProps> & {
     textInputPlaceholder?: string;
 
     /** Hint for the text input */
-    textInputHint?: string;
+    textInputHint?: MaybePhraseKey;
 
     /** Value for the text input */
     textInputValue?: string;
@@ -274,6 +279,9 @@ type BaseSelectionListProps<TItem extends ListItem> = Partial<ChildrenProps> & {
     /** Styles for the list header wrapper */
     listHeaderWrapperStyle?: StyleProp<ViewStyle>;
 
+    /**  Whether to auto focus the Search Input */
+    autoFocus?: boolean;
+
     /** Whether to wrap long text up to 2 lines */
     isRowMultilineSupported?: boolean;
 };

diff --git a/src/libs/Navigation/types.ts b/src/libs/Navigation/types.ts
@@ -605,7 +605,7 @@ type AuthScreensParamList = SharedScreensParamList & {
     };
 };
 
-type RootStackParamList = PublicScreensParamList & AuthScreensParamList;
+type RootStackParamList = PublicScreensParamList & AuthScreensParamList & SearchNavigatorParamList;
 
 type BottomTabName = keyof BottomTabNavigatorParamList;
 

diff --git a/src/libs/OptionsListUtils.ts b/src/libs/OptionsListUtils.ts
@@ -1723,7 +1723,7 @@ function getOptions(
 /**
  * Build the options for the Search view
  */
-function getSearchOptions(reports: Record<string, Report>, personalDetails: OnyxEntry<PersonalDetailsList>, searchValue = '', betas: Beta[] = []): GetOptions {
+function getSearchOptions(reports: OnyxCollection<Report>, personalDetails: OnyxEntry<PersonalDetailsList>, searchValue = '', betas: Beta[] = []): GetOptions {
     Timing.start(CONST.TIMING.LOAD_SEARCH_OPTIONS);
     Performance.markStart(CONST.TIMING.LOAD_SEARCH_OPTIONS);
     const options = getOptions(reports, personalDetails, {

diff --git a/src/pages/RoomMembersPage.tsx b/src/pages/RoomMembersPage.tsx
@@ -204,7 +204,7 @@ function RoomMembersPage({report, session, policies}: RoomMembersPageProps) {
             });
         });
 
-        result = result.sort((value1, value2) => localeCompare(value1.text, value2.text));
+        result = result.sort((value1, value2) => localeCompare(value1.text ?? '', value2.text ?? ''));
 
         return result;
     };

diff --git a/src/pages/SearchPage/index.js → src/pages/SearchPage/index.tsx b/src/pages/SearchPage/index.js → src/pages/SearchPage/index.tsx
@@ -1,8 +1,8 @@
-import PropTypes from 'prop-types';
+import type {StackScreenProps} from '@react-navigation/stack';
 import React, {useEffect, useMemo, useState} from 'react';
 import {View} from 'react-native';
+import type {OnyxCollection, OnyxEntry} from 'react-native-onyx';
 import {withOnyx} from 'react-native-onyx';
-import _ from 'underscore';
 import HeaderWithBackButton from '@components/HeaderWithBackButton';
 import {usePersonalDetails} from '@components/OnyxProvider';
 import ScreenWrapper from '@components/ScreenWrapper';
@@ -12,59 +12,56 @@ import useDebouncedState from '@hooks/useDebouncedState';
 import useLocalize from '@hooks/useLocalize';
 import useNetwork from '@hooks/useNetwork';
 import useThemeStyles from '@hooks/useThemeStyles';
+import type {MaybePhraseKey} from '@libs/Localize';
 import Navigation from '@libs/Navigation/Navigation';
+import type {RootStackParamList} from '@libs/Navigation/types';
 import * as OptionsListUtils from '@libs/OptionsListUtils';
 import Performance from '@libs/Performance';
 import * as ReportUtils from '@libs/ReportUtils';
-import reportPropTypes from '@pages/reportPropTypes';
 import * as Report from '@userActions/Report';
 import Timing from '@userActions/Timing';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
+import type SCREENS from '@src/SCREENS';
+import type * as OnyxTypes from '@src/types/onyx';
 import SearchPageFooter from './SearchPageFooter';
 
-const propTypes = {
-    /* Onyx Props */
-
+type SearchPageOnyxProps = {
     /** Beta features list */
-    betas: PropTypes.arrayOf(PropTypes.string),
+    betas: OnyxEntry<OnyxTypes.Beta[]>;
 
     /** All reports shared with the user */
-    reports: PropTypes.objectOf(reportPropTypes),
+    reports: OnyxCollection<OnyxTypes.Report>;
 
     /** Whether or not we are searching for reports on the server */
-    isSearchingForReports: PropTypes.bool,
-
-    /**
-     * The navigation prop passed by the navigator.
-     *
-     * This is required because transitionEnd event doesn't trigger in the automated testing environment.
-     */
-    navigation: PropTypes.shape({}),
+    isSearchingForReports: OnyxEntry<boolean>;
 };
 
-const defaultProps = {
-    betas: [],
-    reports: {},
-    isSearchingForReports: false,
-    navigation: {},
+type SearchPageProps = SearchPageOnyxProps & StackScreenProps<RootStackParamList, typeof SCREENS.SEARCH_ROOT>;
+
+type SearchPageSectionItem = {
+    data: ReportUtils.OptionData[];
+    shouldShow: boolean;
+    indexOffset: number;
 };
 
+type SearchPageSectionList = SearchPageSectionItem[];
+
 const setPerformanceTimersEnd = () => {
     Timing.end(CONST.TIMING.SEARCH_RENDER);
     Performance.markEnd(CONST.TIMING.SEARCH_RENDER);
 };
 
 const SearchPageFooterInstance = <SearchPageFooter />;
 
-function SearchPage({betas, reports, isSearchingForReports, navigation}) {
+function SearchPage({betas, reports, isSearchingForReports, navigation}: SearchPageProps) {
     const [isScreenTransitionEnd, setIsScreenTransitionEnd] = useState(false);
     const {translate} = useLocalize();
     const {isOffline} = useNetwork();
     const themeStyles = useThemeStyles();
     const personalDetails = usePersonalDetails();
 
-    const offlineMessage = isOffline ? [`${translate('common.youAppearToBeOffline')} ${translate('search.resultsAreLimited')}`, {isTranslated: true}] : '';
+    const offlineMessage: MaybePhraseKey = isOffline ? [`${translate('common.youAppearToBeOffline')} ${translate('search.resultsAreLimited')}`, {isTranslated: true}] : '';
 
     const [searchValue, debouncedSearchValue, setSearchValue] = useDebouncedState('');
 
@@ -85,24 +82,24 @@ function SearchPage({betas, reports, isSearchingForReports, navigation}) {
     } = useMemo(() => {
         if (!isScreenTransitionEnd) {
             return {
-                recentReports: {},
-                personalDetails: {},
-                userToInvite: {},
+                recentReports: [],
+                personalDetails: [],
+                userToInvite: null,
                 headerMessage: '',
             };
         }
-        const options = OptionsListUtils.getSearchOptions(reports, personalDetails, debouncedSearchValue.trim(), betas);
+        const options = OptionsListUtils.getSearchOptions(reports, personalDetails, debouncedSearchValue.trim(), betas ?? []);
         const header = OptionsListUtils.getHeaderMessage(options.recentReports.length + options.personalDetails.length !== 0, Boolean(options.userToInvite), debouncedSearchValue);
         return {...options, headerMessage: header};
     }, [debouncedSearchValue, reports, personalDetails, betas, isScreenTransitionEnd]);
 
-    const sections = useMemo(() => {
-        const newSections = [];
+    const sections = useMemo((): SearchPageSectionList => {
+        const newSections: SearchPageSectionList = [];
         let indexOffset = 0;
 
-        if (recentReports.length > 0) {
+        if (recentReports?.length > 0) {
             newSections.push({
-                data: _.map(recentReports, (report) => ({...report, isBold: report.isUnread})),
+                data: recentReports.map((report) => ({...report, isBold: report.isUnread})),
                 shouldShow: true,
                 indexOffset,
             });
@@ -129,7 +126,7 @@ function SearchPage({betas, reports, isSearchingForReports, navigation}) {
         return newSections;
     }, [localPersonalDetails, recentReports, userToInvite]);
 
-    const selectReport = (option) => {
+    const selectReport = (option: ReportUtils.OptionData) => {
         if (!option) {
             return;
         }
@@ -138,7 +135,7 @@ function SearchPage({betas, reports, isSearchingForReports, navigation}) {
             setSearchValue('');
             Navigation.dismissModal(option.reportID);
         } else {
-            Report.navigateToAndOpenReport([option.login]);
+            Report.navigateToAndOpenReport(option.login ? [option.login] : []);
         }
     };
 
@@ -163,7 +160,7 @@ function SearchPage({betas, reports, isSearchingForReports, navigation}) {
                         onBackButtonPress={Navigation.goBack}
                     />
                     <View style={[themeStyles.flex1, themeStyles.w100, safeAreaPaddingBottomStyle]}>
-                        <SelectionList
+                        <SelectionList<ReportUtils.OptionData>
                             sections={didScreenTransitionEnd && isOptionsDataReady ? sections : CONST.EMPTY_ARRAY}
                             ListItem={UserListItem}
                             textInputValue={searchValue}
@@ -176,7 +173,7 @@ function SearchPage({betas, reports, isSearchingForReports, navigation}) {
                             onSelectRow={selectReport}
                             showLoadingPlaceholder={!didScreenTransitionEnd || !isOptionsDataReady}
                             footerContent={SearchPageFooterInstance}
-                            isLoadingNewOptions={isSearchingForReports}
+                            isLoadingNewOptions={isSearchingForReports ?? undefined}
                         />
                     </View>
                 </>
@@ -185,11 +182,9 @@ function SearchPage({betas, reports, isSearchingForReports, navigation}) {
     );
 }
 
-SearchPage.propTypes = propTypes;
-SearchPage.defaultProps = defaultProps;
 SearchPage.displayName = 'SearchPage';
 
-export default withOnyx({
+export default withOnyx<SearchPageProps, SearchPageOnyxProps>({
     reports: {
         key: ONYXKEYS.COLLECTION.REPORT,
     },

diff --git a/src/pages/workspace/WorkspaceMembersPage.tsx b/src/pages/workspace/WorkspaceMembersPage.tsx
@@ -366,7 +366,7 @@ function WorkspaceMembersPage({policyMembers, personalDetails, route, policy, se
             });
         });
 
-        result = result.sort((a, b) => a.text.toLowerCase().localeCompare(b.text.toLowerCase()));
+        result = result.sort((a, b) => (a.text ?? '').toLowerCase().localeCompare((b.text ?? '').toLowerCase()));
 
         return result;
     };
-Original file line number
+Diff line change
@@ Expand Up / @@ -605,7 +605,7 @@ type AuthScreensParamList = SharedScreensParamList & { @@
         };
     };
-    type RootStackParamList = PublicScreensParamList & AuthScreensParamList;
+    type RootStackParamList = PublicScreensParamList & AuthScreensParamList & SearchNavigatorParamList;
     type BottomTabName = keyof BottomTabNavigatorParamList;
@@ Expand Down @@