Giftable donations

package.json

@@ -26,7 +26,7 @@
     "@mui/material": "^5.11.8",
     "@next/bundle-analyzer": "^10.1.3",
     "@paypal/react-paypal-js": "^7.8.2",
-    "@planet-sdk/common": "^0.1.34",
+    "@planet-sdk/common": "^0.1.42",
     "@sentry/browser": "^6.2.5",
     "@sentry/integrations": "^6.2.5",
     "@sentry/node": "^6.2.5",

pages/index.tsx

@@ -11,7 +11,7 @@
 import { setCountryCode } from "src/Utils/setCountryCode";
 import { DONATE } from "src/Utils/donationStepConstants";
 import {
-  SentGift,
+  GiftDetails,
   FetchedProjectDetails,
   PaymentOptions,
 } from "src/Common/Types";
@@ -20,11 +20,13 @@
   ContactDetails,
 } from "@planet-sdk/common/build/types/donation";
 import { GetServerSideProps } from "next/types";
+import { createProjectDetails } from "src/Utils/createProjectDetails";
+import { NON_GIFTABLE_PROJECT_PURPOSES } from "src/Utils/projects/constants";
 
 interface Props {
   projectDetails?: FetchedProjectDetails;
   donationStep: number | null;
-  giftDetails: SentGift | null;
+  giftDetails: GiftDetails | null;
   isGift: boolean;
   resolvedUrl?: string;
   isDirectDonation: boolean;
@@ -79,7 +81,7 @@
     setSelectedProjects,
     loadselectedProjects,
     setGiftDetails,
-    setisGift,
+    setIsGift,
     setpaymentSetup,
     setcurrency,
     setContactDetails,
@@ -129,7 +131,7 @@
     // If gift details are present, initialize gift in context
     if (giftDetails && isGift) {
       setGiftDetails(giftDetails);
-      setisGift(true);
+      setIsGift(true);
     }
   }, []);
 
@@ -208,36 +210,36 @@
 
 export default index;
 
 export const getServerSideProps: GetServerSideProps = async (context) => {
   let donationStep = 0;
   let showErrorCard = false;
   let projectDetails: FetchedProjectDetails | null = null;
 
   // Variables that will be affected with Gift details
   let isGift = false;
-  let giftDetails: SentGift | null = null;
+  let giftDetails: GiftDetails | null = null;
   let frequency = "once";
   // Variables that will be affected with context
   let hideTaxDeduction = false;
   let isTaxDeductible = false;
   let donationID = null;
   let shouldCreateDonation = false;
   let country = "";
   let isDirectDonation = false;
   let contactDetails: ContactDetails | null = null;
   let units: number | null = 50;
   let allowTaxDeductionChange = true;
   let currency = "EUR";
   let paymentSetup: PaymentOptions | null = null;
   let amount = 0;
   let tenant = "ten_I9TW3ncG";
   let callbackUrl = "";
   let callbackMethod = "";
   let utmCampaign = "";
   let utmMedium = "";
   let utmSource = "";
   const locale = context.locale || "en";
 
   function setshowErrorCard() {
     showErrorCard = true;
   }
@@ -250,7 +252,7 @@
     const queryCountry = context.query.country;
     const found = countriesData.some(
       (country) =>
-        country.countryCode?.toUpperCase() === queryCountry.toUpperCase(),
+        country.countryCode?.toUpperCase() === queryCountry.toUpperCase()
     );
     if (found) {
       country = queryCountry.toUpperCase();
@@ -276,18 +278,7 @@
         const paymentOptionsResponse = await apiRequest(requestParams);
         const paymentOptionsData: PaymentOptions = paymentOptionsResponse?.data;
         if (paymentOptionsData) {
-          projectDetails = {
-            id: paymentOptionsData.id,
-            name: paymentOptionsData.name,
-            description: paymentOptionsData.description,
-            purpose: paymentOptionsData.purpose,
-            ownerName: paymentOptionsData.ownerName,
-            taxDeductionCountries: paymentOptionsData.taxDeductionCountries,
-            image: paymentOptionsData.image,
-            ownerAvatar: paymentOptionsData.ownerAvatar,
-            isApproved: paymentOptionsData.isApproved ? true : false,
-            isTopProject: paymentOptionsData.isTopProject ? true : false,
-          };
+          projectDetails = createProjectDetails(paymentOptionsData);
           donationStep = 1;
         }
       } catch (err) {
@@ -360,26 +351,15 @@
           if (paymentSetupData) {
             currency = paymentSetupData.currency;
             paymentSetup = paymentSetupData;
-            projectDetails = {
-              id: paymentSetupData.id,
-              name: paymentSetupData.name,
-              description: paymentSetupData.description,
-              purpose: paymentSetupData.purpose,
-              ownerName: paymentSetupData.ownerName,
-              taxDeductionCountries: paymentSetupData.taxDeductionCountries,
-              image: paymentSetupData.image,
-              ownerAvatar: paymentSetupData.ownerAvatar,
-              isApproved: paymentSetupData.isApproved ? true : false,
-              isTopProject: paymentSetupData.isTopProject ? true : false,
-            };
+            projectDetails = createProjectDetails(paymentSetupData);
             donationStep = 3;
           }
         } catch (err) {
           // console.log(err);
         }
         allowTaxDeductionChange = false;
         units = donation.units;
-        amount = donation.amount;
+        amount = Number(donation.amount);
         // Setting contact details from donor details
         if (donorData) {
           contactDetails = {
@@ -429,29 +409,49 @@
   if (typeof context.query.utm_source === "string")
     utmSource = context.query.utm_source;
 
-  // Set gift details if there is s (support link) in the query params
-  if (context.query.s) {
-    try {
-      const requestParams = {
-        url: `/app/profiles/${context.query.s}`,
-        setshowErrorCard,
-        tenant,
-        locale,
+  // Handle s (support link) in the query params
+  if (typeof context.query.s === "string" && context.query.s.length > 0) {
+    if (
+      projectDetails === null ||
+      projectDetails.classification === "membership" ||
+      NON_GIFTABLE_PROJECT_PURPOSES.includes(projectDetails.purpose)
+    ) {
+      // If project cannot have direct gift, remove 's' parameter by redirecting
+      const pathname = context.resolvedUrl.split("?")[0];
+      const query = { ...context.query };
+      delete query.s;
+      const queryString = new URLSearchParams(
+        query as Record<string, string>
+      ).toString();
+
+      return {
+        redirect: {
+          destination: `${pathname}${queryString ? `?${queryString}` : ""}`,
+          permanent: true,
+        },
       };
-      const newProfile = await apiRequest(requestParams);
-      if (newProfile.data.type !== "tpo") {
-        isGift = true;
-        giftDetails = {
-          recipientName: newProfile.data.displayName,
-          recipientEmail: "",
-          message: "",
-          type: "direct",
-          recipient: newProfile.data.id,
-          recipientTreecounter: newProfile.data.slug,
+    } else {
+      // Set gift details if there is s (support link) in the query params for an eligible project
+      try {
+        const requestParams = {
+          url: `/app/profiles/${context.query.s}`,
+          setshowErrorCard,
+          tenant,
+          locale,
         };
+        const newProfile = await apiRequest(requestParams);
+        if (newProfile.data.type !== "tpo") {
+          isGift = true;
+          giftDetails = {
+            recipientName: newProfile.data.displayName,
+            type: "direct",
+            recipient: newProfile.data.id,
+            recipientProfile: newProfile.data.slug,
+          };
+        }
+      } catch (err) {
+        console.log("Error", err);
       }
-    } catch (err) {
-      console.log("Error", err);
     }
   }
 

public/locales/en/common.json

@@ -118,7 +118,7 @@
   "selectLanguage": "Select Language",
   "trees": "trees",
   "logout": "Logout",
-  "directGiftRecipient": "This donation supports {{name}}'s Forest",
+  "giftDedicatedTo": "This donation is dedicated to {{name}}",
   "saveGiftDetails": "Save Gift Details",
   "giftSomeone": "My donation is dedicated to someone",
   "or": "OR",
@@ -223,4 +223,4 @@
   "top_project_standards_fulfilled": "The project inspection revealed that this project fulfilled at least 12 of the 19 Top Project <2>standards.</2>",
   "standardsLink": "https://www.plant-for-the-planet.org/standards/",
   "enterValidEmail": "Please enter a valid email"
-}
+}

src/Common/Types/QueryParamContextInterface.ts

@@ -1,10 +1,10 @@
 import {
   CurrencyList,
   FetchedProjectDetails,
+  GiftDetails,
   OnBehalfDonor,
   PaymentOptions,
   PlanetCashSignupDetails,
-  SentGift,
 } from ".";
 import { ProjectMapInfo as Project } from "@planet-sdk/common/build/types/project";
 import { User } from "@planet-sdk/common/build/types/user";
@@ -20,9 +20,9 @@ import { Dispatch, SetStateAction } from "react";
 
 export default interface QueryParamContextInterface {
   isGift: boolean;
-  setisGift: Dispatch<SetStateAction<boolean>>;
-  giftDetails: SentGift | NoGift;
-  setGiftDetails: Dispatch<SetStateAction<SentGift | NoGift>>;
+  setIsGift: Dispatch<SetStateAction<boolean>>;
+  giftDetails: GiftDetails | NoGift;
+  setGiftDetails: Dispatch<SetStateAction<GiftDetails | NoGift>>;
   contactDetails: ContactDetails;
   setContactDetails: Dispatch<SetStateAction<ContactDetails>>;
   country: string;

src/Common/Types/index.tsx

@@ -14,8 +14,16 @@ import {
 } from "@planet-sdk/common";
 
 /** planet-donations only allows direct or invitation gifts */
+export type DirectGiftDetails = SentDirectGift & {
+  recipientName?: string;
+  recipientProfile?: string;
+};
+export type InvitationGiftDetails = SentInvitationGift;
+
 export type SentGift = SentDirectGift | SentInvitationGift;
 
+export type GiftDetails = DirectGiftDetails | InvitationGiftDetails;
+
 export interface PaymentProviderRequest {
   account?: string;
   gateway: PaymentGateway;
@@ -38,7 +46,7 @@ export interface CreateDonationFunctionProps {
   paymentSetup: PaymentOptions;
   currency: string;
   contactDetails: ContactDetails;
-  giftDetails: SentGift | NoGift;
+  giftDetails: GiftDetails | NoGift;
   isGift: boolean;
   setIsPaymentProcessing: Dispatch<SetStateAction<boolean>>;
   setPaymentError: Dispatch<SetStateAction<string>>;
@@ -101,7 +109,7 @@ export interface CreateDonationDataProps {
   contactDetails: ContactDetails;
   taxDeductionCountry: string | null;
   isGift: boolean;
-  giftDetails: SentGift | NoGift;
+  giftDetails: GiftDetails | NoGift;
   frequency: string;
   amount?: number | null;
   callbackUrl: string | undefined;
@@ -119,19 +127,40 @@ export interface PlanetCashSignupDetails {
   purpose: "planet-cash-signup";
 }
 
-export interface FetchedProjectDetails {
+export interface FetchedBaseProjectDetails {
   id: string;
   name: string;
   description?: string | null;
   ownerAvatar: string | null;
   ownerName: string | null;
   image?: string | null;
   purpose: ProjectPurpose;
+  classification: Nullable<ProjectClassification>;
   taxDeductionCountries?: Array<string>;
   isApproved: boolean;
   isTopProject: boolean;
 }
 
+export interface FetchedTreeProjectDetails extends FetchedBaseProjectDetails {
+  purpose: "trees";
+  classification: TreeProjectClassification;
+}
+
+export interface FetchedFundsProjectDetails extends FetchedBaseProjectDetails {
+  purpose: "funds";
+  classification: FundsProjectClassification;
+}
+
+export interface FetchedOtherProjectDetails extends FetchedBaseProjectDetails {
+  purpose: "conservation" | "reforestation" | "bouquet" | "planet-cash";
+  classification: null;
+}
+
+export type FetchedProjectDetails =
+  | FetchedTreeProjectDetails
+  | FetchedFundsProjectDetails
+  | FetchedOtherProjectDetails;
+
 export type ProjectPurpose =
   | "trees"
   | "conservation"
@@ -140,7 +169,36 @@ export type ProjectPurpose =
   | "bouquet"
   | "planet-cash";
 
-export interface PaymentOptions extends FetchedProjectDetails {
+export type TreeProjectClassification =
+  | "agroforestry"
+  | "managed-regeneration"
+  | "large-scale-planting"
+  | "mangroves"
+  | "natural-regeneration"
+  | "other-planting"
+  | "urban-planting";
+
+export type FundsProjectClassification =
+  | "academy"
+  | "endowment"
+  | "forest-protection"
+  | "funding"
+  | "membership"
+  | "mixed"
+  | "neutral"
+  | "neutral-event"
+  | "penalty"
+  | "public-funds"
+  | "research"
+  | "sponsorship"
+  | "subscription"
+  | "subsidy";
+
+export type ProjectClassification =
+  | TreeProjectClassification
+  | FundsProjectClassification;
+
+export type PaymentOptions = FetchedProjectDetails & {
   requestedCountry: string;
   effectiveCountry: string;
   frequencies: Frequencies;
@@ -152,7 +210,7 @@ export interface PaymentOptions extends FetchedProjectDetails {
   unitCost: number;
   currency: string;
   destination: string;
-}
+};
 
 export type UnitType = "tree" | "m2" | "currency" | CurrencyCode;