refactor(types): replace 'any' with generic types in PUT authenticate…

… request
Plant-for-the-Planet-org · Jan 17, 2025 · f91b377 · f91b377
1 parent 07d99a3
commit f91b377
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 29 deletions.
diff --git a/src/features/user/ManageProjects/components/ProjectMedia.tsx b/src/features/user/ManageProjects/components/ProjectMedia.tsx
@@ -33,12 +33,16 @@ import { useUserProps } from '../../../common/Layout/UserPropsContext';
 import { ProjectCreationTabs } from '..';
 import { useTenant } from '../../../common/Layout/TenantContext';
 
-type SubmitData = {
+type PostSubmitData = {
   imageFile: string;
   description: string | null;
   isDefault: boolean;
 };
 
+type VideoSubmitData = {
+  videoUrl: string;
+};
+
 export default function ProjectMedia({
   handleBack,
   token,
@@ -90,14 +94,14 @@ export default function ProjectMedia({
   const uploadPhotos = async (image: string) => {
     setIsUploadingData(true);
 
-    const submitData: SubmitData = {
+    const submitData: PostSubmitData = {
       imageFile: image,
       description: null,
       isDefault: false,
     };
 
     try {
-      const res = await postAuthenticatedRequest<UploadImage, SubmitData>({
+      const res = await postAuthenticatedRequest<UploadImage, PostSubmitData>({
         tenant: tenantConfig?.id,
         url: `/app/projects/${projectGUID}/images`,
         data: submitData,
@@ -171,13 +175,14 @@ export default function ProjectMedia({
   const onSubmit = async (data: { youtubeURL: string }) => {
     // Add isDirty test here
     setIsUploadingData(true);
-    const submitData = {
+    const submitData: VideoSubmitData = {
       videoUrl: data.youtubeURL,
     };
 
     try {
       const res = await putAuthenticatedRequest<
-        ProfileProjectTrees | ProfileProjectConservation
+        ProfileProjectTrees | ProfileProjectConservation,
+        VideoSubmitData
       >({
         tenant: tenantConfig?.id,
         url: `/app/projects/${projectGUID}`,

diff --git a/src/features/user/ManageProjects/components/ProjectSites.tsx b/src/features/user/ManageProjects/components/ProjectSites.tsx
@@ -59,6 +59,12 @@ const Map = dynamic(() => import('./MapComponent'), {
   loading: () => <p></p>,
 });
 
+type SubmitData = {
+  name: string;
+  geometry: GeoJson<Geometry, GeoJsonProperties>;
+  status: string;
+};
+
 function EditSite({
   openModal,
   handleModalClose,
@@ -102,14 +108,14 @@ function EditSite({
   const editProjectSite = async (data: ProjectSitesFormData) => {
     if (geoJson && geoJson.features && geoJson.features.length !== 0) {
       setIsUploadingData(true);
-      const submitData = {
+      const submitData: SubmitData = {
         name: siteDetails.name,
         geometry: geoJson,
         status: data.status,
       };
 
       try {
-        const res = await putAuthenticatedRequest<Site>({
+        const res = await putAuthenticatedRequest<Site, SubmitData>({
           tenant: tenantConfig?.id,
           url: `/app/projects/${projectGUID}/sites/${siteGUID}`,
           data: submitData,
@@ -262,12 +268,6 @@ interface ProjectSitesFormData {
   status: string;
 }
 
-type SubmitData = {
-  name: string;
-  geometry: GeoJson<Geometry, GeoJsonProperties>;
-  status: string;
-};
-
 export default function ProjectSites({
   handleBack,
   token,

diff --git a/src/features/user/Profile/ForestProgress/TargetsModal.tsx b/src/features/user/Profile/ForestProgress/TargetsModal.tsx
@@ -23,6 +23,14 @@ interface TargetsModalProps {
   conservTarget: number;
 }
 
+type SubmitData = {
+  targets: {
+    treesDonated: number;
+    areaRestored: number;
+    areaConserved: number;
+  };
+};
+
 const TargetsModal = ({
   open,
   setOpen,
@@ -66,7 +74,7 @@ const TargetsModal = ({
   const handleTargets = async () => {
     setIsTargetModalLoading(true);
     if (contextLoaded && token && open && !isTargetModalLoading) {
-      const bodyToSend = {
+      const bodyToSend: SubmitData = {
         targets: {
           treesDonated: isTreesPlantedTargetActive
             ? treesPlantedTargetLocal
@@ -80,7 +88,7 @@ const TargetsModal = ({
         },
       };
       try {
-        const res = await putAuthenticatedRequest<User>({
+        const res = await putAuthenticatedRequest<User, SubmitData>({
           tenant: tenantConfig?.id,
           url: `/app/profile`,
           data: bodyToSend,

diff --git a/src/features/user/Settings/EditProfile/AddressManagement/EditAddress.tsx b/src/features/user/Settings/EditProfile/AddressManagement/EditAddress.tsx
@@ -1,6 +1,11 @@
 import type { ExtendedCountryCode } from '../../../../common/types/country';
 import type { SetState } from '../../../../common/types/common';
-import type { Address, APIError } from '@planet-sdk/common';
+import type {
+  Address,
+  AddressType,
+  APIError,
+  CountryCode,
+} from '@planet-sdk/common';
 import type { FormData } from './AddAddress';
 import type { AddressAction } from '../../../../common/types/profile';
 
@@ -21,6 +26,11 @@ interface Props {
   setAddressAction: SetState<AddressAction | null>;
 }
 
+type SubmitData = FormData & {
+  country: CountryCode | string;
+  type: AddressType;
+};
+
 const EditAddress = ({
   setIsModalOpen,
   selectedAddressForAction,
@@ -48,13 +58,13 @@ const EditAddress = ({
     async (data: FormData) => {
       if (!contextLoaded || !user || !token) return;
       setIsLoading(true);
-      const bodyToSend = {
+      const bodyToSend: SubmitData = {
         ...data,
         country,
         type: selectedAddressForAction?.type,
       };
       try {
-        const res = await putAuthenticatedRequest<Address>({
+        const res = await putAuthenticatedRequest<Address, SubmitData>({
           tenant: tenantConfig.id,
           url: `/app/addresses/${selectedAddressForAction?.id}`,
           data: bodyToSend,

diff --git a/src/features/user/Settings/EditProfile/AddressManagement/UnsetBillingAddress.tsx b/src/features/user/Settings/EditProfile/AddressManagement/UnsetBillingAddress.tsx
@@ -22,6 +22,10 @@ interface Props {
   selectedAddressForAction: Address;
 }
 
+type SubmitData = {
+  type: 'other';
+};
+
 const UnsetBillingAddress = ({
   addressType,
   setIsModalOpen,
@@ -39,11 +43,11 @@ const UnsetBillingAddress = ({
   const unsetAddress = async () => {
     if (!contextLoaded || !user || !token) return;
     setIsLoading(true);
-    const bodyToSend = {
+    const bodyToSend: SubmitData = {
       type: ADDRESS_TYPE.OTHER,
     };
     try {
-      const res = await putAuthenticatedRequest<Address>({
+      const res = await putAuthenticatedRequest<Address, SubmitData>({
         tenant: tenantConfig.id,
         url: `/app/addresses/${selectedAddressForAction.id}`,
         data: bodyToSend,

diff --git a/src/features/user/Settings/EditProfile/AddressManagement/UpdateAddressType.tsx b/src/features/user/Settings/EditProfile/AddressManagement/UpdateAddressType.tsx
@@ -23,6 +23,10 @@ interface Props {
   setAddressAction: SetState<AddressAction | null>;
 }
 
+type SubmitData = {
+  type: 'primary' | 'mailing';
+};
+
 const UpdateAddressType = ({
   addressType,
   setIsModalOpen,
@@ -41,11 +45,11 @@ const UpdateAddressType = ({
   const updateAddress = async (addressType: 'primary' | 'mailing') => {
     if (!contextLoaded || !user || !token) return;
     setIsUploadingData(true);
-    const bodyToSend = {
+    const bodyToSend: SubmitData = {
       type: addressType,
     };
     try {
-      const res = await putAuthenticatedRequest<Address>({
+      const res = await putAuthenticatedRequest<Address, SubmitData>({
         tenant: tenantConfig.id,
         url: `/app/addresses/${selectedAddressForAction.id}`,
         data: bodyToSend,

diff --git a/src/features/user/Settings/EditProfile/EditProfileForm.tsx b/src/features/user/Settings/EditProfile/EditProfileForm.tsx
@@ -59,6 +59,9 @@ type ProfileTypeOption = {
   value: 'individual' | 'organization' | 'education';
 };
 
+type SubmitData = {
+  imageFile: string | ArrayBuffer | null | undefined;
+};
 export default function EditProfileForm() {
   const [snackbarOpen, setSnackbarOpen] = useState(false);
   const { setErrors } = React.useContext(ErrorHandlingContext);
@@ -160,11 +163,9 @@ export default function EditProfileForm() {
     reset();
   }, [type]);
 
-  const handleUserProfileImage = async (bodyToSend: {
-    imageFile: string | ArrayBuffer | null | undefined;
-  }) => {
+  const handleUserProfileImage = async (bodyToSend: SubmitData) => {
     try {
-      const res = await putAuthenticatedRequest<User>({
+      const res = await putAuthenticatedRequest<User, SubmitData>({
         tenant: tenantConfig?.id,
         url: `/app/profile`,
         data: bodyToSend,

diff --git a/src/features/user/Settings/ImpersonateUser/SupportPin.tsx b/src/features/user/Settings/ImpersonateUser/SupportPin.tsx
@@ -21,7 +21,7 @@ const SupportPin = () => {
         token,
         logoutUser,
       });
-      if (response) {
+      if (response && user) {
         const updateUserData = { ...user };
         updateUserData['supportPin'] = response?.supportPin;
         setUser(updateUserData);

diff --git a/src/features/user/Widget/EmbedModal.tsx b/src/features/user/Widget/EmbedModal.tsx
@@ -19,6 +19,9 @@ interface Props {
   setEmbedModalOpen: Function;
 }
 
+type SubmitData = {
+  isPrivate: boolean;
+};
 const Alert = styled(MuiAlert)(({ theme }) => {
   return {
     backgroundColor: theme.palette.primary.main,
@@ -56,12 +59,12 @@ export default function EmbedModal({
 
   const saveProfile = async () => {
     setIsUploadingData(true);
-    const bodyToSend = {
+    const bodyToSend: SubmitData = {
       isPrivate: false,
     };
     if (contextLoaded && token) {
       try {
-        const res = await putAuthenticatedRequest<User>({
+        const res = await putAuthenticatedRequest<User, SubmitData>({
           tenant: tenantConfig?.id,
           url: `/app/profile`,
           data: bodyToSend,