[No QA] [TS Migration] migrate withNavigation.js to TypeScript

.eslintrc.js

@@ -116,7 +116,7 @@ module.exports = {
                     },
                     {
                         selector: ['parameter', 'method'],
-                        format: ['camelCase'],
+                        format: ['camelCase', 'PascalCase'],
                     },
                 ],
                 '@typescript-eslint/ban-types': [

src/components/withNavigation.tsx

@@ -0,0 +1,24 @@
+import React, {ComponentType, ForwardedRef, RefAttributes} from 'react';
+import {NavigationProp, useNavigation} from '@react-navigation/native';
+import getComponentDisplayName from '../libs/getComponentDisplayName';
+
+type WithNavigationProps = {
+    navigation: NavigationProp<ReactNavigation.RootParamList>;
+};
+
+export default function withNavigation<TProps extends WithNavigationProps, TRef>(WrappedComponent: ComponentType<TProps & RefAttributes<TRef>>) {
+    function WithNavigation(props: Omit<TProps, keyof WithNavigationProps>, ref: ForwardedRef<TRef>) {
+        const navigation = useNavigation();
+        return (
+            <WrappedComponent
+                // eslint-disable-next-line react/jsx-props-no-spreading
+                {...(props as TProps)}
+                ref={ref}
+                navigation={navigation}
+            />
+        );
+    }
+
+    WithNavigation.displayName = `withNavigation(${getComponentDisplayName(WrappedComponent)})`;
+    return React.forwardRef(WithNavigation);
+}

src/libs/Navigation/AppNavigator/Navigators/RightModalNavigator.js

@@ -1,19 +1,22 @@
 import React from 'react';
 import {View} from 'react-native';
 import {createStackNavigator} from '@react-navigation/stack';
+import PropTypes from 'prop-types';
 
 import * as ModalStackNavigators from '../ModalStackNavigators';
 import RHPScreenOptions from '../RHPScreenOptions';
 import useWindowDimensions from '../../../../hooks/useWindowDimensions';
-import {withNavigationPropTypes} from '../../../../components/withNavigation';
 import styles from '../../../../styles/styles';
 import Overlay from './Overlay';
 import NoDropZone from '../../../../components/DragAndDrop/NoDropZone';
 
 const Stack = createStackNavigator();
 
 const propTypes = {
-    ...withNavigationPropTypes,
+    /* Navigation functions provided by React Navigation */
+    navigation: PropTypes.shape({
+        goBack: PropTypes.func.isRequired,
+    }).isRequired,
 };
 
 function RightModalNavigator(props) {

src/libs/Navigation/AppNavigator/ReportScreenIDSetter.js

@@ -5,7 +5,6 @@ import {withOnyx} from 'react-native-onyx';
 import ONYXKEYS from '../../../ONYXKEYS';
 import * as ReportUtils from '../../ReportUtils';
 import reportPropTypes from '../../../pages/reportPropTypes';
-import {withNavigationPropTypes} from '../../../components/withNavigation';
 import * as App from '../../actions/App';
 import usePermissions from '../../../hooks/usePermissions';
 import CONST from '../../../CONST';
@@ -40,7 +39,10 @@ const propTypes = {
         }),
     }).isRequired,
 
-    ...withNavigationPropTypes,
+    /* Navigation functions provided by React Navigation */
+    navigation: PropTypes.shape({
+        setParams: PropTypes.func.isRequired,
+    }).isRequired,
 };
 
 const defaultProps = {

src/libs/Navigation/AppNavigator/ReportScreenWrapper.js

@@ -1,6 +1,5 @@
 import PropTypes from 'prop-types';
 import React from 'react';
-import {withNavigationPropTypes} from '../../../components/withNavigation';
 import ReportScreen from '../../../pages/home/ReportScreen';
 import ReportScreenIDSetter from './ReportScreenIDSetter';
 
@@ -17,7 +16,10 @@ const propTypes = {
         }),
     }).isRequired,
 
-    ...withNavigationPropTypes,
+    /* Navigation functions provided by React Navigation */
+    navigation: PropTypes.shape({
+        setParams: PropTypes.func.isRequired,
+    }).isRequired,
 };
 
 const defaultProps = {};

src/libs/getComponentDisplayName.ts

@@ -1,6 +1,6 @@
 import {ComponentType} from 'react';
 
 /** Returns the display name of a component */
-export default function getComponentDisplayName(component: ComponentType): string {
+export default function getComponentDisplayName<TProps>(component: ComponentType<TProps>): string {
     return component.displayName ?? component.name ?? 'Component';
 }