refactor: cleaned up and optimized code

Author: AkhilTheBoss

client/src/api.ts

@@ -29,6 +29,10 @@ import {
   TableOfContents,
   User,
   UserSearchParams,
+  BaseInvitation,
+  Sender,
+  ProjectSummary,
+  InvitationsResponse,
 } from "./types";
 import {
   AddableProjectTeamMember,
@@ -1019,6 +1023,84 @@ class API {
       params,
     });
   }
+
+  // Project Invitations
+  async createProjectInvitation(
+    projectID: string,
+    email: string,
+    role: string
+  ) {
+    const res = await axios.post<{ 
+      responseInvitation: BaseInvitation
+    } & ConductorBaseResponse>(
+      `/project-invitations/${projectID}`,
+      {
+        email,
+        role
+      }
+    );
+    return res.data;
+  }
+
+  async getAllProjectInvitations(
+    projectID: string, 
+    page: number = 1, 
+    limit: number
+  ) {
+    const res = await axios.get<{
+      data: InvitationsResponse;
+    } & ConductorBaseResponse>(`/project-invitations/project/${projectID}`, {
+      params: { page, limit },
+    });
+    return res.data;
+  }
+
+  async getProjectInvitation(
+    inviteID: string, 
+    token: string | null
+  ) {
+    const res = await axios.get<{
+      invitation: BaseInvitation & {sender: Sender} & {project: ProjectSummary};
+    } & ConductorBaseResponse>(`/project-invitations/${inviteID}`, {
+      params: { token },
+    });
+    return res.data;
+  }
+
+  async deleteInvitation(invitationId: string) {
+    const res = await axios.delete<
+      {
+        deleted: boolean;
+      } & ConductorBaseResponse
+    >(`/project-invitations/${invitationId}`);
+  
+    return res.data;
+  }
+  
+  async updateInvitationRole(inviteID: string, role: string) {
+    const res = await axios.put<
+      {
+        updatedInvitation: BaseInvitation;
+      } & ConductorBaseResponse
+    >(`/project-invitations/${inviteID}/update`, { role });
+  
+    return res.data; 
+  }
+  
+  async acceptProjectInvitation(inviteID: string | null, token: string | null){
+    const res = await axios.post<{ 
+      data: string
+    } & ConductorBaseResponse>(
+      `/project-invitation/${inviteID}/accept`,
+      {},
+      {
+        params: {token},
+      }
+    );
+
+    return res.data;
+  }
+
 }
 
 export default new API();

client/src/components/projects/ManageTeamModal.tsx

@@ -107,15 +107,8 @@ const ManageTeamModal: React.FC<ManageTeamModalProps> = ({
       }
 
       setLoading(true);
-      const res = await axios.post(`/project-invitations/${project.projectID}`, {
-        email: inviteEmail,
-        role: "member"
-      });
+      const res = await api.createProjectInvitation(project.projectID, inviteEmail, "member");
 
-      if (res.data.err) {
-        handleGlobalError(res.data.errMsg);
-        return;
-      }
 
       setInviteEmail("");
       setCurrentPage(1);
@@ -131,14 +124,12 @@ const ManageTeamModal: React.FC<ManageTeamModalProps> = ({
   const fetchPendingInvitations = async (page: number = 1) => {
     try {
       setInvitationsLoading(true);
-      const res = await axios.get(`/project-invitations/project/${project.projectID}?page=${page}&limit=${ITEMS_PER_PAGE}`);
 
-      if (res.data.err) {
-        throw new Error(res.data.errMsg);
-      }
+      const res = await api.getAllProjectInvitations(project.projectID, page, ITEMS_PER_PAGE);
+
 
-      setPendingInvitations(res.data.data.invitations || []);
-      setTotalPages(Math.ceil(res.data.data.total / ITEMS_PER_PAGE));
+      setPendingInvitations(res.data.invitations || []);
+      setTotalPages(Math.ceil(res.data.total / ITEMS_PER_PAGE));
     } catch (err) {
       handleGlobalError(err);
     } finally {
@@ -149,10 +140,7 @@ const ManageTeamModal: React.FC<ManageTeamModalProps> = ({
   const handleDeleteInvitation = async (invitationId: string) => {
     try {
       setLoading(true);
-      const res = await axios.delete(`/project-invitations/${invitationId}`);
-      if (res.data.err) {
-        throw new Error(res.data.errMsg);
-      }
+      const res = await api.deleteInvitation(invitationId);
       await fetchPendingInvitations();
     } catch (err) {
       handleGlobalError(err);
@@ -163,11 +151,13 @@ const ManageTeamModal: React.FC<ManageTeamModalProps> = ({
 
   useEffect(() => {
     const fetchData = async () => {
-      await fetchPendingInvitations();
+      if (show) {  // Only fetch if modal is shown
+        await fetchPendingInvitations();
+      }
     };
 
     fetchData();
-  }, []);
+  }, [show]);
 
   /**
    * Retrieves a list of users that can be added as team members to the
@@ -260,12 +250,7 @@ const ManageTeamModal: React.FC<ManageTeamModalProps> = ({
         throw new Error("Invalid invite ID or role. This may be caused by an internal error.");
       }
       setLoading(true);
-      const res = await axios.put(`/project-invitations/${inviteID}/update`, { role });
-  
-      if (res.data.err) {
-        handleGlobalError(res.data.errMsg);
-        return;
-      }
+      const res = await api.updateInvitationRole(inviteID, role);
 
       await fetchPendingInvitations(currentPage);
       onDataChanged(); 

client/src/screens/conductor/Projects/AcceptProjectInviteScreen.tsx

@@ -3,6 +3,7 @@ import { useLocation, Link } from "react-router-dom";
 import { Image, Button, Grid, Container } from "semantic-ui-react";
 import axios from "axios";
 import useGlobalError from "../../../components/error/ErrorHooks";
+import api from "../../../api";
 
 function AcceptProjectInviteScreen() {
   const location = useLocation();
@@ -29,26 +30,26 @@ function AcceptProjectInviteScreen() {
 
   const checkInviteStatus = async (inviteID: string, token: string | null) => {
     try {
-      const response = await axios.get(`/project-invitations/${inviteID}?token=${token}`);
-      const projectID = response.data.data.projectID;
+      const response = await api.getProjectInvitation(inviteID, token);
+      const projectID = response.invitation.projectID;
 
-      if (response.data.data.accepted) {
+      if (response.invitation.accepted) {
         window.location.href = `/projects/${projectID}`; 
         return;
       }
 
-      setProjectTitle(response.data.data.project.title);
-    } catch (error: any) {
-      handleGlobalError(error.response?.data?.errMsg || "An unexpected error occurred.");
+      setProjectTitle(response.invitation.project.title);
+    } catch (error) {
+      handleGlobalError(error);
     }
   };
 
   const handleAccept = async () => {
     try {
-      const response = await axios.post(`/project-invitation/${inviteID}/accept?token=${token}`);
-      window.location.href = `/projects/${response.data.data}`; // Redirect after accepting
-    } catch (error: any) {
-      handleGlobalError(error.response?.data?.errMsg || "An unexpected error occurred.");
+      const response = await api.acceptProjectInvitation(inviteID, token);
+      window.location.href = `/projects/${response.data}`; // Redirect after accepting
+    } catch (error) {
+      handleGlobalError(error);
     }
   };
 

client/src/types/ProjectInvitation.ts

@@ -0,0 +1,40 @@
+export type Sender = {
+  uuid: string;
+  firstName: string;
+  lastName: string;
+};
+
+export type ProjectSummary = {
+  projectID: string;
+  title: string;
+};
+  
+export type BaseInvitation = {
+    projectID: string;
+    senderID: string;
+    email: string;
+    role: string;
+    accepted: boolean;
+    expires: string;
+    inviteID: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+export type Invitation = BaseInvitation & {
+    sender: Sender;
+};
+
+export type GetInvitationResponse = BaseInvitation & {
+    project: ProjectSummary;
+    sender: Sender;
+};
+
+export type InvitationsResponse = {
+    invitations: Invitation[];
+    total: number;
+    pagination: {
+      page: number;
+      limit: number;
+    };
+};

client/src/types/index.ts

@@ -20,6 +20,7 @@ export * from "./OrgEvent";
 export * from "./PeerReview";
 export * from "./PeerReviewRubric";
 export * from "./Project";
+export * from "./ProjectInvitation"
 export * from "./support";
 export * from "./Search";
 export * from "./User";

package-lock.json

@@ -36,7 +36,7 @@ import orgEventsAPI from "./api/orgevents.js";
 import paymentsAPI from "./api/payments.js";
 import kbAPI from "./api/kb.js";
 import supportAPI from "./api/support.js";
-import projectInvitationsAPI from "./api/projectinvitations.ts";
+import projectInvitationsAPI from "./api/projectinvitations.js";
 
 import * as centralIdentityValidators from "./api/validators/central-identity.js";
 import * as collectionValidators from "./api/validators/collections.js";
@@ -49,7 +49,7 @@ import * as AssetTagFrameworkValidators from "./api/validators/assettagframework
 import * as AuthorsValidators from "./api/validators/authors.js";
 import * as BookValidators from "./api/validators/book.js";
 import * as UserValidators from "./api/validators/user.js";
-import * as ProjectInvitationValidators from "./api/validators/project-invitations.ts";
+import * as ProjectInvitationValidators from "./api/validators/project-invitations.js";
 
 const router = express.Router();
 
@@ -2297,6 +2297,12 @@ router
     middleware.validateZod(ProjectInvitationValidators.getProjectInvitationSchema),
     projectInvitationsAPI.getProjectInvitation
   )
+  .delete(
+    authAPI.verifyRequest,
+    authAPI.getUserAttributes,
+    middleware.validateZod(ProjectInvitationValidators.deleteProjectInvitationSchema),
+    projectInvitationsAPI.deleteProjectInvitation
+  )
 
 router
   .route("/project-invitations/project/:projectID")
@@ -2307,15 +2313,6 @@ router
     projectInvitationsAPI.getAllInvitationsForProject
   )
 
-router
-  .route("/project-invitations/:inviteID")  
-  .delete(
-    authAPI.verifyRequest,
-    authAPI.getUserAttributes,
-    middleware.validateZod(ProjectInvitationValidators.deleteProjectInvitationSchema),
-    projectInvitationsAPI.deleteProjectInvitation
-  )
-
 router
   .route("/project-invitation/:inviteID/accept")
   .post(