docs and rename getallprojectpreviews

chpy04 · chpy04 · commit ca0c84a25717 · 2025-09-25T21:30:14.000-04:00
diff --git a/src/backend/src/controllers/projects.controllers.ts b/src/backend/src/controllers/projects.controllers.ts
@@ -23,9 +23,9 @@ export default class ProjectsController {
     }
   }
 
-  static async getAllProjectPreviews(req: Request, res: Response, next: NextFunction) {
+  static async getAllProjects(req: Request, res: Response, next: NextFunction) {
     try {
-      const projects: ProjectPreview[] = await ProjectsService.getAllProjectPreviews(req.organization);
+      const projects: ProjectPreview[] = await ProjectsService.getAllProjects(req.organization);
       res.status(200).json(projects);
     } catch (error: unknown) {
       next(error);
diff --git a/src/backend/src/routes/projects.routes.ts b/src/backend/src/routes/projects.routes.ts
@@ -12,7 +12,7 @@ import ProjectsController from '../controllers/projects.controllers';
 const projectRouter = express.Router();
 
 projectRouter.get('/all-gantt', ProjectsController.getAllProjectsGantt);
-projectRouter.get('/all-previews', ProjectsController.getAllProjectPreviews);
+projectRouter.get('/all-previews', ProjectsController.getAllProjects);
 projectRouter.get('/users-teams', ProjectsController.getUsersTeamsProjects);
 projectRouter.get('/leading', ProjectsController.getUsersLeadingProjects);
 projectRouter.get('/teams-projects/:teamId', ProjectsController.getTeamsProjects);
diff --git a/src/backend/src/services/projects.services.ts b/src/backend/src/services/projects.services.ts
@@ -64,7 +64,7 @@ export default class ProjectsService {
    * @param organization the organization the user is in
    * @returns all the projects with preview query args
    */
-  static async getAllProjectPreviews(organization: Organization): Promise<ProjectPreview[]> {
+  static async getAllProjects(organization: Organization): Promise<ProjectPreview[]> {
     const projects = await prisma.project.findMany({
       where: { wbsElement: { dateDeleted: null, organizationId: organization.organizationId } },
       ...getProjectPreviewQueryArgs(organization.organizationId)
@@ -141,7 +141,7 @@ export default class ProjectsService {
    * Get the projects for a given team
    * @param organization
    * @param teamId
-   * @returns
+   * @returns all the projects for the given team with full project query args
    */
   static async getTeamsProjects(organization: Organization, teamId: string): Promise<Project[]> {
     const projects = await prisma.project.findMany({
diff --git a/src/frontend/src/apis/projects.api.ts b/src/frontend/src/apis/projects.api.ts
@@ -28,15 +28,18 @@ import {
 import { CreateSingleProjectPayload, EditSingleProjectPayload } from '../utils/types';
 
 /**
- * Fetches all projects.
+ * Fetches all projects with querry args needed for Gantt chart
  */
 export const getAllProjectsGantt = () => {
   return axios.get<ProjectGantt[]>(apiUrls.allProjectsGantt(), {
     transformResponse: (data) => JSON.parse(data).map(projectGanttTransformer)
   });
 };
 
-export const getAllProjectPreviews = () => {
+/**
+ * Fetches all projects with preview querry args
+ */
+export const getAllProjects = () => {
   return axios.get<ProjectPreview[]>(apiUrls.allProjectPreviews(), {
     transformResponse: (data) => JSON.parse(data).map(projectPreviewTransformer)
   });
diff --git a/src/frontend/src/hooks/projects.hooks.ts b/src/frontend/src/hooks/projects.hooks.ts
@@ -35,13 +35,13 @@ import {
   setAbbreviation,
   deleteAbbreviation,
   getTeamsProjects,
-  getAllProjectPreviews
+  getAllProjects
 } from '../apis/projects.api';
 import { CreateSingleProjectPayload, EditSingleProjectPayload } from '../utils/types';
 import { useCurrentUser } from './users.hooks';
 
 /**
- * Custom React Hook to supply all projects.
+ * Custom React Hook to supply all projects with Gantt querry args
  */
 export const useAllProjectsGantt = () => {
   return useQuery<ProjectGantt[], Error>(['projects'], async () => {
@@ -50,27 +50,39 @@ export const useAllProjectsGantt = () => {
   });
 };
 
-export const useAllProjectsPreviews = () => {
+/**
+ * Custom React Hook to supply all projects
+ */
+export const useAllProjects = () => {
   return useQuery<ProjectPreview[], Error>(['projects', 'previews'], async () => {
-    const { data } = await getAllProjectPreviews();
+    const { data } = await getAllProjects();
     return data;
   });
 };
 
+/**
+ * Custom React Hook to supply all of the projects that are on the users teams
+ */
 export const useGetUsersTeamsProjects = () => {
   return useQuery<ProjectOverview[], Error>(['projects', 'teams'], async () => {
     const { data } = await getUsersTeamsProjects();
     return data;
   });
 };
 
+/**
+ * Custom React Hook to supply all of the projects that the user is the manager or lead of
+ */
 export const useGetUsersLeadingProjects = () => {
   return useQuery<ProjectOverview[], Error>(['projects', 'leading'], async () => {
     const { data } = await getUsersLeadingProjects();
     return data;
   });
 };
 
+/**
+ * Custom React Hook to supply all of the projects for a given team
+ */
 export const useGetTeamsProjects = (teamId: string) => {
   return useQuery<Project[], Error>(['projects', 'teams'], async () => {
     const { data } = await getTeamsProjects(teamId);
diff --git a/src/frontend/src/pages/AdminToolsPage/EditGuestView/EditFeaturedProjectsDropdown.tsx b/src/frontend/src/pages/AdminToolsPage/EditGuestView/EditFeaturedProjectsDropdown.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import { Autocomplete, Chip, TextField } from '@mui/material';
 import { ProjectPreview } from 'shared';
 import { projectWbsNamePipe } from '../../../utils/pipes';
-import { useAllProjectsPreviews } from '../../../hooks/projects.hooks';
+import { useAllProjects } from '../../../hooks/projects.hooks';
 import LoadingIndicator from '../../../components/LoadingIndicator';
 import ErrorPage from '../../ErrorPage';
 
@@ -12,7 +12,7 @@ interface EditFeatureProjectsDropdownProps {
 }
 
 const EditFeaturedProjectsDropdown: React.FC<EditFeatureProjectsDropdownProps> = ({ onChange, value }) => {
-  const { data: allProjects, isLoading, isError, error } = useAllProjectsPreviews();
+  const { data: allProjects, isLoading, isError, error } = useAllProjects();
 
   if (isLoading || !allProjects) return <LoadingIndicator />;
   if (isError) return <ErrorPage message={error.message} />;
diff --git a/src/frontend/src/pages/AdminToolsPage/ProjectsConfig/AbbreviationsTable.tsx b/src/frontend/src/pages/AdminToolsPage/ProjectsConfig/AbbreviationsTable.tsx
@@ -1,7 +1,7 @@
 import { Box, IconButton, TableCell, TableRow, Typography } from '@mui/material';
 import AdminToolTable from '../AdminToolTable';
 import { NERButton } from '../../../components/NERButton';
-import { useAllProjectsPreviews, useDeleteProjectAbbreviation } from '../../../hooks/projects.hooks';
+import { useAllProjects, useDeleteProjectAbbreviation } from '../../../hooks/projects.hooks';
 import LoadingIndicator from '../../../components/LoadingIndicator';
 import ErrorPage from '../../ErrorPage';
 import SetAbbreviationModal from './SetAbbreviationModal';
@@ -11,12 +11,7 @@ import { Delete } from '@mui/icons-material';
 import NERModal from '../../../components/NERModal';
 
 const AbbreviationsTable: React.FC = () => {
-  const {
-    data: projects,
-    isLoading: projectsIsLoading,
-    isError: projectsIsError,
-    error: projectsError
-  } = useAllProjectsPreviews();
+  const { data: projects, isLoading: projectsIsLoading, isError: projectsIsError, error: projectsError } = useAllProjects();
   const { mutateAsync } = useDeleteProjectAbbreviation();
   const [openModal, setOpenModal] = useState(false);
   const [abbreviationToDelete, setAbbreviationToDelete] = useState<ProjectPreview>();
diff --git a/src/frontend/src/pages/AdminToolsPage/ProjectsConfig/SetAbbreviationModal.tsx b/src/frontend/src/pages/AdminToolsPage/ProjectsConfig/SetAbbreviationModal.tsx
@@ -5,7 +5,7 @@ import ReactHookTextField from '../../../components/ReactHookTextField';
 import * as yup from 'yup';
 import { yupResolver } from '@hookform/resolvers/yup';
 import { wbsPipe } from 'shared';
-import { useAllProjectsPreviews, useSetProjectAbbreviation } from '../../../hooks/projects.hooks';
+import { useAllProjects, useSetProjectAbbreviation } from '../../../hooks/projects.hooks';
 import LoadingIndicator from '../../../components/LoadingIndicator';
 import ErrorPage from '../../ErrorPage';
 
@@ -20,12 +20,7 @@ interface SetAbbreviation {
 }
 
 const SetAbbreviationModal: React.FC<SetAbbreviation> = ({ open, handleClose }) => {
-  const {
-    data: projects,
-    isLoading: projectsIsLoading,
-    isError: projectsIsError,
-    error: projectsError
-  } = useAllProjectsPreviews();
+  const { data: projects, isLoading: projectsIsLoading, isError: projectsIsError, error: projectsError } = useAllProjects();
   const { mutateAsync } = useSetProjectAbbreviation();
 
   const onFormSubmit = async (data: { wbsNum: string; abbreviation: string }) => {
diff --git a/src/frontend/src/pages/CreateChangeRequestPage/CreateChangeRequestView.tsx b/src/frontend/src/pages/CreateChangeRequestPage/CreateChangeRequestView.tsx
@@ -32,7 +32,7 @@ import {
   Select
 } from '@mui/material';
 import NERAutocomplete from '../../components/NERAutocomplete';
-import { useAllProjectsPreviews } from '../../hooks/projects.hooks';
+import { useAllProjects } from '../../hooks/projects.hooks';
 import ErrorPage from '../ErrorPage';
 import LoadingIndicator from '../../components/LoadingIndicator';
 import NERFailButton from '../../components/NERFailButton';
@@ -91,7 +91,7 @@ const CreateChangeRequestsView: React.FC<CreateChangeRequestViewProps> = ({
 
   const { fields: whys, append: appendWhy, remove: removeWhy } = useFieldArray({ control, name: 'why' });
 
-  const { isLoading, isError, error, data: projects } = useAllProjectsPreviews();
+  const { isLoading, isError, error, data: projects } = useAllProjects();
 
   const permittedTypes = Object.values(ChangeRequestType).filter(
     (t) => t !== ChangeRequestType.Activation && t !== ChangeRequestType.StageGate && t !== ChangeRequestType.Budget
diff --git a/src/frontend/src/pages/FinancePage/ReimbursementRequestForm/ReimbursementRequestForm.tsx b/src/frontend/src/pages/FinancePage/ReimbursementRequestForm/ReimbursementRequestForm.tsx
@@ -21,7 +21,7 @@ import CreateReimbursementRequestFormView from './ReimbursementFormView';
 import { useHistory, useLocation } from 'react-router-dom';
 import { routes } from '../../../utils/routes';
 import { useCurrentUserSecureSettings } from '../../../hooks/users.hooks';
-import { useAllProjectsPreviews } from '../../../hooks/projects.hooks';
+import { useAllProjects } from '../../../hooks/projects.hooks';
 
 export interface ReimbursementRequestInformation {
   vendorId: string;
@@ -190,7 +190,7 @@ const ReimbursementRequestForm: React.FC<ReimbursementRequestFormProps> = ({
     isError: allProjectsIsError,
     error: allProjectsError,
     data: allProjects
-  } = useAllProjectsPreviews();
+  } = useAllProjects();
 
   // checking the data here instead of using isError since function doesn't ever return an error
   const { data: userSecureSettings, isLoading: checkSecureSettingsIsLoading } = useCurrentUserSecureSettings();
diff --git a/src/frontend/src/pages/ProjectsPage/ProjectsTable.tsx b/src/frontend/src/pages/ProjectsPage/ProjectsTable.tsx
@@ -8,7 +8,7 @@ import { DataGrid, GridColDef, GridFilterModel, GridRow, GridRowProps } from '@m
 import { useEffect, useState } from 'react';
 import { Link as RouterLink } from 'react-router-dom';
 import { Project, WbsElementStatus, WbsNumber, WorkPackage } from 'shared';
-import { useAllProjectsPreviews } from '../../hooks/projects.hooks';
+import { useAllProjects } from '../../hooks/projects.hooks';
 import { fullNamePipe, wbsPipe, weeksPipe } from '../../utils/pipes';
 import { routes } from '../../utils/routes';
 import { GridColDefStyle } from '../../utils/tables';
@@ -19,7 +19,7 @@ import { getProjectTeamsName } from '../ProjectDetailPage/ProjectViewContainer/P
  * Table of all projects.
  */
 const ProjectsTable: React.FC = () => {
-  const { isLoading, data, error } = useAllProjectsPreviews();
+  const { isLoading, data, error } = useAllProjects();
   if (!localStorage.getItem('projectsTableRowCount')) localStorage.setItem('projectsTableRowCount', '30');
   const [pageSize, setPageSize] = useState(localStorage.getItem('projectsTableRowCount'));
   const [windowSize, setWindowSize] = useState(window.innerWidth);
diff --git a/src/frontend/src/utils/urls.ts b/src/frontend/src/utils/urls.ts
@@ -32,7 +32,7 @@ const logUserOut = () => `${users()}/auth/log-out`;
 /**************** Projects Endpoints ****************/
 const projects = () => `${API_URL}/projects`;
 const allProjectsGantt = () => `${projects()}/all-gantt`;
-const allProjectPreviews = () => `${projects()}/all-previews`;
+const allProjects = () => `${projects()}/all-previews`;
 const usersTeamsProjects = () => `${projects()}/users-teams`;
 const usersLeadingProjects = () => `${projects()}/leading`;
 const teamsProjects = (teamId: string) => `${projects()}/teams-projects/${teamId}`;
@@ -447,7 +447,7 @@ export const apiUrls = {
 
   projects,
   allProjectsGantt,
-  allProjectPreviews,
+  allProjectPreviews: allProjects,
   projectsByWbsNum,
   projectsCreate,
   projectsEdit,

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ export default class ProjectsController {`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`
`26`		`- static async getAllProjectPreviews(req: Request, res: Response, next: NextFunction) {`
	`26`	`+ static async getAllProjects(req: Request, res: Response, next: NextFunction) {`
`27`	`27`	`try {`
`28`		`- const projects: ProjectPreview[] = await ProjectsService.getAllProjectPreviews(req.organization);`
	`28`	`+ const projects: ProjectPreview[] = await ProjectsService.getAllProjects(req.organization);`
`29`	`29`	`res.status(200).json(projects);`
`30`	`30`	`} catch (error: unknown) {`
`31`	`31`	`next(error);`