Merge pull request #3386 from Northeastern-Electric-Racing/#3376-JhonyelGalvis-HookUpGet/Put/Delete

created the hooks for getting sponsors, sponsor-tasks, deleting a spo…

Author: walker-sean

src/frontend/src/apis/finance.api.ts

@@ -2,13 +2,15 @@
  * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
  * See the LICENSE file in the repository root folder for details.
  */
+import { sponsorTaskTranformer, sponsorTransformer } from '../../../backend/src/transformers/finance.transformer';
 import {
   CreateReimbursementRequestPayload,
   EditReimbursementRequestPayload,
   EditVendorPayload,
   AccountCodePayload,
   RefundPayload,
   MarkDeliveredRequestPayload,
+  EditSponsorTaskPayload,
   SponsorPayload,
   SponsorTierPayload,
   SponsorTaskPayload
@@ -22,7 +24,7 @@ import {
 } from './transformers/reimbursement-requests.transformer';
 import { saveAs } from 'file-saver';
 import { PDFDocument, PDFImage } from 'pdf-lib';
-import { IndexCode, AccountCode, ReimbursementRequest, OtherProductReason } from 'shared';
+import { IndexCode, AccountCode, ReimbursementRequest, OtherProductReason, Sponsor, SponsorTask } from 'shared';
 
 enum AllowedFileType {
   JPEG = 'image/jpeg',
@@ -424,7 +426,7 @@ export const createSponsorTask = async (sponsorId: string, sponsorTaskData: Spon
  */
 export const getAllIndexCodes = () => {
   return axios.get<IndexCode[]>(apiUrls.getAllIndexCodes(), {
-    transformResponse: (data) => JSON.parse(data) as IndexCode[]
+    transformResponse: (data) => JSON.parse(data)
   });
 };
 
@@ -435,6 +437,56 @@ export const getAllIndexCodes = () => {
  */
 export const getAllOtherProductReason = () => {
   return axios.get<OtherProductReason[]>(apiUrls.getAllOtherProductReasons(), {
-    transformResponse: (data) => JSON.parse(data) as OtherProductReason[]
+    transformResponse: (data) => JSON.parse(data)
   });
 };
+
+/**
+ * API call to get the list of all sponsors
+ *
+ * @returns the list of all sponsors
+ */
+
+export const getAllSponsors = () => {
+  return axios.get<Sponsor[]>(apiUrls.getAllSponsors(), {
+    transformResponse: (data) => JSON.parse(data).map(sponsorTransformer)
+  });
+};
+
+/**
+ * API call to the sponsor tasks for a given sponsor
+ *
+ * @param sponsorId the id of the sponsor which tasks are retrieved
+ *
+ * @returns the list of tasks for a given sponsor
+ */
+
+export const getSponsorTasks = (sponsorId: string) => {
+  return axios.get<SponsorTask[]>(apiUrls.getSponsorTasks(sponsorId), {
+    transformResponse: (data) => JSON.parse(data).map(sponsorTaskTranformer)
+  });
+};
+
+/**
+ * API call to delete a given sponsor
+ *
+ * @param sponsorId the id of the sponsor to delete
+ *
+ * @returns the deleted sponsor
+ */
+
+export const deleteSponsor = (sponsorId: string) => {
+  return axios.delete(apiUrls.deleteSponsor(sponsorId));
+};
+
+/**
+ * API call to edit a sponsor task
+ *
+ * @param sponsorTaskData the edited data of the sponsor task
+ * @param sponsorTaskId the id of the sponsor task to be edited
+ *
+ * @returns the edited sponosor task
+ */
+export const editSponsorTask = (sponsorTaskId: string, sponsorTaskData: EditSponsorTaskPayload) => {
+  return axios.post(apiUrls.editSponsorTask(sponsorTaskId), sponsorTaskData);
+};

src/frontend/src/hooks/finance.hooks.ts

@@ -37,7 +37,11 @@ import {
   createSponsorTask,
   createSponsorTier,
   getAllIndexCodes,
-  getAllOtherProductReason
+  getAllOtherProductReason,
+  getAllSponsors,
+  getSponsorTasks,
+  editSponsorTask,
+  deleteSponsor
 } from '../apis/finance.api';
 import {
   IndexCode,
@@ -50,10 +54,10 @@ import {
   OtherReimbursementProductCreateArgs,
   WbsReimbursementProductCreateArgs,
   ReimbursementStatusType,
-  SponsorTask,
+  OtherProductReason,
   Sponsor,
-  SponsorTier,
-  OtherProductReason
+  SponsorTask,
+  SponsorTier
 } from 'shared';
 import { fullNamePipe } from '../utils/pipes';
 
@@ -190,6 +194,13 @@ export interface IndexCodePayload {
   name: string;
 }
 
+export interface EditSponsorTaskPayload {
+  dueDate: Date;
+  notes: string;
+  notifyDate?: Date;
+  asigneeId?: string;
+}
+
 /**
  * Custom React Hook to upload a new picture.
  */
@@ -715,3 +726,68 @@ export const useGetAllOtherProductReason = () => {
     return data;
   });
 };
+
+/**
+ * custom React Hook to get all the sponsors
+ *
+ * @returns the list of all of the sponsors
+ */
+export const useGetAllSponsors = () => {
+  return useQuery<Sponsor[], Error>(['sponsor'], async () => {
+    const { data } = await getAllSponsors();
+    return data;
+  });
+};
+
+/**
+ * custom react hook to get all of the sponsor tasks for a given sponsor
+ *
+ * @returns the list of all of the sponsor tasks for a given sponsor
+ */
+export const useGetSponsorTasks = (sponsorId: string) => {
+  return useQuery<SponsorTask[], Error>(['sponsor-task'], async () => {
+    const { data } = await getSponsorTasks(sponsorId);
+    return data;
+  });
+};
+
+/**
+ * Custom React Hook to edit a sponsor task
+ *
+ * @param sponsorTaskId the id of the sponsor task to be edited
+ *
+ * @returns the edited sponosor task
+ */
+export const useEditSponsorTask = (sponsorTaskId: string) => {
+  const queryClient = useQueryClient();
+  return useMutation<SponsorTask, Error, EditSponsorTaskPayload>(
+    ['sponsor-task', 'edit'],
+    async (formData: EditSponsorTaskPayload) => {
+      const { data } = await editSponsorTask(sponsorTaskId, formData);
+      queryClient.invalidateQueries(['sponsor-task']);
+      return data;
+    }
+  );
+};
+
+/**
+ * Custom React Hook to delete a sponsor
+ *
+ * @param sponsorId the id of the sponsor to be deleted
+ * @returns the deleted sponsor
+ */
+export const useDeleteSponsor = (sponsorId: string) => {
+  const queryClient = useQueryClient();
+  return useMutation<Sponsor, Error>(
+    ['sponsor', 'delete'],
+    async () => {
+      const { data } = await deleteSponsor(sponsorId);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['sponsor']);
+      }
+    }
+  );
+};

src/frontend/src/utils/urls.ts

@@ -148,6 +148,10 @@ const financeCreateSponsorTier = () => `${financeRoutesEndpoints()}/sponsorTier/
 const financeCreateSponsorTask = (sponsorId: string) => `${financeRoutesEndpoints()}/sponsor/${sponsorId}/sponsorTasks`;
 const getAllIndexCodes = () => `${financeEndpoints()}/index-codes`;
 const getAllOtherProductReasons = () => `${financeEndpoints()}/other-reimbursement-product-reasons`;
+const getAllSponsors = () => `${financeRoutesEndpoints()}/sponsors`;
+const getSponsorTasks = (sponsorId: string) => `${financeRoutesEndpoints()}/sponsors/${sponsorId}/sponsorTasks`;
+const deleteSponsor = (sponsorId: string) => `${financeRoutesEndpoints()}/sponsors/${sponsorId}/delete`;
+const editSponsorTask = (sponsorTaskId: string) => `${financeRoutesEndpoints()}/sponsorTask/${sponsorTaskId}/edit`;
 
 /**************** Bill of Material Endpoints **************************/
 const bomEndpoints = () => `${API_URL}/projects/bom`;
@@ -377,6 +381,10 @@ export const apiUrls = {
   financeCreateSponsorTask,
   getAllIndexCodes,
   getAllOtherProductReasons,
+  getAllSponsors,
+  getSponsorTasks,
+  deleteSponsor,
+  editSponsorTask,
 
   bomEndpoints,
   bomGetMaterialsByWbsNum,