refactor(types): replace 'any' with generic types in POST authenticat…

…ed requests
Plant-for-the-Planet-org · Jan 10, 2025 · ef2e23f · ef2e23f
1 parent 6ca92a0
commit ef2e23f
Show file tree

Hide file tree

Showing 16 changed files with 188 additions and 37 deletions.
diff --git a/pages/sites/[slug]/[locale]/claim/[type]/[code].tsx b/pages/sites/[slug]/[locale]/claim/[type]/[code].tsx
@@ -35,6 +35,10 @@ interface Props {
   pageProps: PageProps;
 }
 
+export type RedeemCodeSubmitData = {
+  code: string;
+};
+
 function ClaimDonation({ pageProps }: Props): ReactElement {
   const t = useTranslations('Redeem');
   const router = useRouter();
@@ -79,12 +83,15 @@ function ClaimDonation({ pageProps }: Props): ReactElement {
   };
 
   async function redeemingCode(code: string): Promise<void> {
-    const submitData = {
+    const submitData: RedeemCodeSubmitData = {
       code: code,
     };
     if (contextLoaded && user) {
       try {
-        const res = await postAuthenticatedRequest<RedeemedCodeData>({
+        const res = await postAuthenticatedRequest<
+          RedeemedCodeData,
+          RedeemCodeSubmitData
+        >({
           tenant: pageProps.tenantConfig.id,
           url: `/app/redeem`,
           data: submitData,

diff --git a/pages/sites/[slug]/[locale]/profile/redeem/[code].tsx b/pages/sites/[slug]/[locale]/profile/redeem/[code].tsx
@@ -8,6 +8,7 @@ import type { AbstractIntlMessages } from 'next-intl';
 import type { APIError, SerializedError } from '@planet-sdk/common';
 import type { Tenant } from '@planet-sdk/common/build/types/tenant';
 import type { RedeemedCodeData } from '../../../../../../src/features/common/types/redeem';
+import type { RedeemCodeSubmitData } from '../../claim/[type]/[code]';
 
 import { useRouter } from 'next/router';
 import { useState, useEffect, useContext } from 'react';
@@ -73,13 +74,16 @@ const RedeemCode = ({ pageProps: { tenantConfig } }: Props) => {
 
   async function redeemingCode(data: string): Promise<void> {
     setIsLoading(true);
-    const submitData = {
+    const submitData: RedeemCodeSubmitData = {
       code: data,
     };
 
     if (contextLoaded && user) {
       try {
-        const res = await postAuthenticatedRequest<RedeemedCodeData>({
+        const res = await postAuthenticatedRequest<
+          RedeemedCodeData,
+          RedeemCodeSubmitData
+        >({
           tenant: tenantConfig?.id,
           url: `/app/redeem`,
           data: submitData,

diff --git a/src/features/user/BulkCodes/forms/IssueCodesForm.tsx b/src/features/user/BulkCodes/forms/IssueCodesForm.tsx
@@ -152,7 +152,10 @@ const IssueCodesForm = (): ReactElement | null => {
       const cleanedData = cleanObject(donationData);
 
       try {
-        const res = await postAuthenticatedRequest<Donation>({
+        const res = await postAuthenticatedRequest<
+          Donation,
+          PrepaidDonationRequest
+        >({
           tenant: tenantConfig?.id,
           url: `/app/donations`,
           data: cleanedData,

diff --git a/src/features/user/ManagePayouts/screens/AddBankAccount.tsx b/src/features/user/ManagePayouts/screens/AddBankAccount.tsx
@@ -17,6 +17,21 @@ import { PayoutCurrency } from '../../../../utils/constants/payoutConstants';
 import { handleError } from '@planet-sdk/common';
 import { useTenant } from '../../../common/Layout/TenantContext';
 
+interface AccountData {
+  currency: string;
+  payoutMinAmount: string | undefined;
+  bankName: string;
+  bankCountry: string;
+  bankAddress: string;
+  holderName: string;
+  holderAddress: string;
+  accountNumber: string;
+  routingNumber: string;
+  bic: string;
+  branchCode: string;
+  remarks: string;
+}
+
 const AddBankAccount = (): ReactElement | null => {
   const t = useTranslations('ManagePayouts');
   const { payoutMinAmounts, setAccounts, accounts } = usePayouts();
@@ -32,14 +47,14 @@ const AddBankAccount = (): ReactElement | null => {
 
   const handleSaveAccount = async (data: FormData) => {
     setIsProcessing(true);
-    const accountData = {
+    const accountData: AccountData = {
       ...data,
       currency: data.currency === PayoutCurrency.DEFAULT ? '' : data.currency,
       payoutMinAmount:
         data.currency === PayoutCurrency.DEFAULT ? '' : data.payoutMinAmount,
     };
     try {
-      const res = await postAuthenticatedRequest<BankAccount>({
+      const res = await postAuthenticatedRequest<BankAccount, AccountData>({
         tenant: tenantConfig?.id,
         url: '/app/accounts',
         data: accountData,

diff --git a/src/features/user/ManageProjects/components/BasicDetails.tsx b/src/features/user/ManageProjects/components/BasicDetails.tsx
@@ -66,6 +66,36 @@ type TreeFormData = FormData & {
 
 type ConservationFormData = FormData;
 
+interface SubmitDataBase {
+  name: string;
+  slug: string;
+  website: string;
+  description: string;
+  acceptDonations: boolean;
+  unitCost: number | undefined;
+  currency: 'EUR'; // Fixed currency
+  metadata: {
+    ecosystem: string;
+    visitorAssistance: boolean;
+  };
+  geometry: {
+    type: 'Point';
+    coordinates: [number, number];
+  };
+}
+
+interface SubmitDataTrees extends SubmitDataBase {
+  unitType: 'tree' | 'm2';
+  classification: string;
+  countTarget: number;
+}
+
+interface SubmitDataConservation extends SubmitDataBase {
+  purpose: 'conservation';
+}
+
+type SubmitData = SubmitDataTrees | SubmitDataConservation;
+
 export default function BasicDetails({
   handleNext,
   token,
@@ -306,7 +336,7 @@ export default function BasicDetails({
 
   const onSubmit = async (data: TreeFormData | ConservationFormData) => {
     setIsUploadingData(true);
-    const submitData =
+    const submitData: SubmitData =
       purpose === 'trees'
         ? {
             name: data.name,
@@ -379,7 +409,8 @@ export default function BasicDetails({
     } else {
       try {
         const res = await postAuthenticatedRequest<
-          ProfileProjectTrees | ProfileProjectConservation
+          ProfileProjectTrees | ProfileProjectConservation,
+          SubmitData
         >({
           tenant: tenantConfig?.id,
           url: `/app/projects`,

diff --git a/src/features/user/ManageProjects/components/ProjectCertificates.tsx b/src/features/user/ManageProjects/components/ProjectCertificates.tsx
@@ -48,6 +48,12 @@ const dialogSx: SxProps = {
   },
 };
 
+type SubmitData = {
+  issueDate: string;
+  certifierName: string;
+  pdfFile: string;
+};
+
 function ProjectCertificates({
   projectGUID,
   token,
@@ -78,14 +84,14 @@ function ProjectCertificates({
   const onSubmit = async (pdf: string) => {
     const { issueDate, certifierName } = getValues();
     setIsUploadingData(true);
-    const submitData = {
+    const submitData: SubmitData = {
       issueDate: issueDate.getFullYear(),
       certifierName: certifierName,
       pdfFile: pdf,
     };
 
     try {
-      const res = await postAuthenticatedRequest<Certificate>({
+      const res = await postAuthenticatedRequest<Certificate, SubmitData>({
         tenant: tenantConfig?.id,
         url: `/app/projects/${projectGUID}/certificates`,
         data: submitData,

diff --git a/src/features/user/ManageProjects/components/ProjectMedia.tsx b/src/features/user/ManageProjects/components/ProjectMedia.tsx
@@ -33,6 +33,12 @@ import { useUserProps } from '../../../common/Layout/UserPropsContext';
 import { ProjectCreationTabs } from '..';
 import { useTenant } from '../../../common/Layout/TenantContext';
 
+type SubmitData = {
+  imageFile: string;
+  description: string | null;
+  isDefault: boolean;
+};
+
 export default function ProjectMedia({
   handleBack,
   token,
@@ -84,14 +90,14 @@ export default function ProjectMedia({
   const uploadPhotos = async (image: string) => {
     setIsUploadingData(true);
 
-    const submitData = {
+    const submitData: SubmitData = {
       imageFile: image,
       description: null,
       isDefault: false,
     };
 
     try {
-      const res = await postAuthenticatedRequest<UploadImage>({
+      const res = await postAuthenticatedRequest<UploadImage, SubmitData>({
         tenant: tenantConfig?.id,
         url: `/app/projects/${projectGUID}/images`,
         data: submitData,

diff --git a/src/features/user/ManageProjects/components/ProjectSites.tsx b/src/features/user/ManageProjects/components/ProjectSites.tsx
@@ -8,7 +8,11 @@ import type {
   Site,
   SitesScopeProjects,
 } from '../../../common/types/project';
-import type { FeatureCollection as GeoJson } from 'geojson';
+import type {
+  FeatureCollection as GeoJson,
+  GeoJsonProperties,
+  Geometry,
+} from 'geojson';
 
 import React from 'react';
 import styles from './../StepForm.module.scss';
@@ -258,6 +262,12 @@ interface ProjectSitesFormData {
   status: string;
 }
 
+type SubmitData = {
+  name: string;
+  geometry: GeoJson<Geometry, GeoJsonProperties>;
+  status: string;
+};
+
 export default function ProjectSites({
   handleBack,
   token,
@@ -369,14 +379,14 @@ export default function ProjectSites({
       if (!data.name) return;
 
       setIsUploadingData(true);
-      const submitData = {
+      const submitData: SubmitData = {
         name: siteDetails.name,
         geometry: geoJson,
         status: data.status,
       };
 
       try {
-        const res = await postAuthenticatedRequest<Site>({
+        const res = await postAuthenticatedRequest<Site, SubmitData>({
           tenant: tenantConfig?.id,
           url: `/app/projects/${projectGUID}/sites`,
           data: submitData,

diff --git a/src/features/user/ManageProjects/components/ProjectSpending.tsx b/src/features/user/ManageProjects/components/ProjectSpending.tsx
@@ -56,7 +56,11 @@ type FormData = {
   year: Date;
   amount: number;
 };
-
+type SubmitData = {
+  year: number;
+  amount: number;
+  pdfFile: string | ArrayBuffer | null | undefined;
+};
 export default function ProjectSpending({
   handleBack,
   token,
@@ -88,14 +92,14 @@ export default function ProjectSpending({
     const updatedAmount = getValues('amount');
     const year = getValues('year');
 
-    const submitData = {
+    const submitData: SubmitData = {
       year: year.getFullYear(),
       amount: updatedAmount,
       pdfFile: pdf,
     };
 
     try {
-      const res = await postAuthenticatedRequest<ProjectExpense>({
+      const res = await postAuthenticatedRequest<ProjectExpense, SubmitData>({
         tenant: tenantConfig?.id,
         url: `/app/projects/${projectGUID}/expenses`,
         data: submitData,

diff --git a/src/features/user/PlanetCash/components/CreateAccountForm.tsx b/src/features/user/PlanetCash/components/CreateAccountForm.tsx
@@ -25,6 +25,25 @@ interface Props {
   allowedCountries: CountryType[];
 }
 
+type SubmitData = {
+  country: ExtendedCountryCode | string;
+  activate: boolean;
+};
+
+type PlanetCash = {
+  id: string;
+  isActive: boolean;
+  ownerName: string;
+  balance: number;
+  debit: number;
+  fee: number;
+  creditLimit: number;
+  currency: 'EUR' | 'USD';
+  country: 'DE' | 'ES' | 'US';
+  topUpThreshold: number;
+  topUpAmount: number;
+};
+
 const CreateAccountForm = ({
   allowedCountries,
   isPlanetCashActive,
@@ -42,11 +61,11 @@ const CreateAccountForm = ({
 
   const onSubmit = async (event: FormEvent<HTMLFormElement>) => {
     event.preventDefault();
-    const data = { country: country, activate: !isPlanetCashActive };
+    const data: Data = { country: country, activate: !isPlanetCashActive };
     setIsProcessing(true);
 
     try {
-      const res = await postAuthenticatedRequest({
+      const res = await postAuthenticatedRequest<PlanetCash, SubmitData>({
         tenant: tenantConfig?.id,
         url: '/app/planetCash',
         data,

diff --git a/src/features/user/Profile/ProfileCard/RedeemModal/index.tsx b/src/features/user/Profile/ProfileCard/RedeemModal/index.tsx
@@ -1,6 +1,7 @@
 import type { ReactElement } from 'react';
 import type { APIError, SerializedError } from '@planet-sdk/common';
 import type { RedeemedCodeData } from '../../../../common/types/redeem';
+import type { RedeemCodeSubmitData } from '../../../../../../pages/sites/[slug]/[locale]/claim/[type]/[code]';
 
 import Modal from '@mui/material/Modal';
 import Fade from '@mui/material/Fade';
@@ -43,14 +44,17 @@ export default function RedeemModal({
     RedeemedCodeData | undefined
   >(undefined);
   const [isLoading, setIsLoading] = React.useState<boolean>(false);
-  async function redeemingCode(data: string | undefined): Promise<void> {
+  async function redeemingCode(data: string): Promise<void> {
     setIsLoading(true);
-    const submitData = {
+    const submitData: RedeemCodeSubmitData = {
       code: data,
     };
     if (contextLoaded && user) {
       try {
-        const res = await postAuthenticatedRequest<RedeemedCodeData>({
+        const res = await postAuthenticatedRequest<
+          RedeemedCodeData,
+          RedeemCodeSubmitData
+        >({
           tenant: tenantConfig?.id,
           url: `/app/redeem`,
           data: submitData,

diff --git a/src/features/user/RegisterTrees/RegisterTrees/UploadImages.tsx b/src/features/user/RegisterTrees/RegisterTrees/UploadImages.tsx
@@ -23,6 +23,11 @@ interface Props {
   token: string | null;
 }
 
+type SubmitData = {
+  imageFile: string;
+  description: string;
+};
+
 export default function UploadImages({
   contributionGUID,
   token,
@@ -36,13 +41,13 @@ export default function UploadImages({
 
   const uploadPhotos = async (image: string) => {
     setIsUploadingData(true);
-    const submitData = {
+    const submitData: SubmitData = {
       imageFile: image,
       description: '',
     };
 
     try {
-      const res = await postAuthenticatedRequest<Image>({
+      const res = await postAuthenticatedRequest<Image, SubmitData>({
         tenant: tenantConfig?.id,
         url: `/app/contributions/${contributionGUID}/images`,
         data: submitData,