give / src / DonationForms / resources / app / hooks / useFormData.ts

useFormData.ts in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/DonationForms/resources/app/hooks/useFormData.ts

143 lines 4.7 KB

Raw Download Zip

1	import type {DonationTotals} from '@givewp/forms/app/store/donation-summary';
2	import {useDonationSummaryContext} from '@givewp/forms/app/store/donation-summary';
3	import type {subscriptionPeriod} from '@givewp/forms/registrars/templates/groups/DonationAmount/subscriptionPeriod';
4
5	/**
6	* Zero decimal currencies are currencies that do not have a minor unit.
7	* For example, the Japanese Yen (JPY) does not have a minor unit.
8	* @since 4.0.0
9	*
10	* @see https://stripe.com/docs/currencies#zero-decimal
11	*/
12	const zeroDecimalCurrencies = [
13	'BIF',
14	'CLP',
15	'DJF',
16	'GNF',
17	'JPY',
18	'KMF',
19	'KRW',
20	'MGA',
21	'PYG',
22	'RWF',
23	'UGX',
24	'VND',
25	'VUV',
26	'XAF',
27	'XOF',
28	'XPF',
29	];
30
31	/**
32	* Takes in an amount value in dollar units and returns the calculated cents (minor) amount
33	*
34	* @since 4.0.0
35	*/
36	const amountToMinorUnit = (amount: string, currency: string) => {
37	if (zeroDecimalCurrencies.includes(currency)) {
38	return Math.round(parseFloat(amount));
39	}
40
41	return Math.round(parseFloat(amount) * 100);
42	};
43
44	/**
45	* Donation total calculation
46	*
47	* @since 4.1.0 Round return value
48	* @since 4.0.0
49	*/
50	const getAmountTotal = (totals: DonationTotals, amount: number) =>
51	normalizeAmount(
52	Number(
53	Object.values({
54	...totals,
55	amount,
56	}).reduce((total: number, amount: number) => {
57	return total + amount;
58	}, 0)
59	)
60	);
61
62	/**
63	* Subscription total calculation
64	* TODO: figure out which totals will be included in subscriptions
65	*
66	* @since 4.1.0 Round return value
67	* @since 4.0.0
68	*/
69	const getSubscriptionTotal = (totals: DonationTotals, amount: number) => {
70	let total = 0;
71
72	// Subscriptions currently only support donation amount (TODO: and potentially feeRecovery values)
73	const allowedKeys = ['feeRecovery'];
74
75	for (const [key, value] of Object.entries(totals)) {
76	if (allowedKeys.includes(key)) {
77	total += value;
78	}
79	}
80
81	return normalizeAmount(Number(total + amount));
82	};
83
84	/**
85	* @since 4.1.0
86	*/
87	const normalizeAmount = (amount: number) => Math.round(amount * 100) / 100;
88
89	/**
90	* @since 4.6.0 Set minor units for donation and subscription amounts when currency is zero decimal
91	* @since 4.0.0
92	*/
93	export default function useFormData() {
94	const {totals} = useDonationSummaryContext();
95	const {useWatch} = window.givewp.form.hooks;
96
97	const firstName = useWatch({name: 'firstName'}) as string;
98	const lastName = useWatch({name: 'lastName'}) as string \| undefined;
99	const email = useWatch({name: 'email'}) as string;
100	const phone = useWatch({name: 'phone'}) as string \| undefined;
101	const billingAddress = {
102	addressLine1: useWatch({name: 'address1'}) as string \| undefined,
103	addressLine2: useWatch({name: 'address2'}) as string \| undefined,
104	city: useWatch({name: 'city'}) as string \| undefined,
105	state: useWatch({name: 'state'}) as string \| undefined,
106	postalCode: useWatch({name: 'zip'}) as string \| undefined,
107	country: useWatch({name: 'country'}) as string \| undefined,
108	};
109	const amount = useWatch({name: 'amount'}) as string;
110	const currency = useWatch({name: 'currency'}) as string;
111	const subscriptionPeriod = useWatch({name: 'subscriptionPeriod'}) as subscriptionPeriod \| undefined;
112	const subscriptionFrequency = useWatch({name: 'subscriptionFrequency'}) as number \| undefined;
113	const subscriptionInstallments = useWatch({name: 'subscriptionInstallments'});
114	const donationType = useWatch({name: 'donationType'}) as 'single' \| 'subscription' \| undefined;
115
116	const amountTotal = getAmountTotal(totals, Number(amount));
117	const amountTotalInMinorUnits = amountToMinorUnit(amountTotal.toString(), currency);
118	const subscriptionAmountTotal = getSubscriptionTotal(totals, Number(amount));
119	const subscriptionAmountTotalInMinorUnits = amountToMinorUnit(subscriptionAmountTotal.toString(), currency);
120
121	const donationAmount = zeroDecimalCurrencies.includes(currency) ? amountTotalInMinorUnits : amountTotal;
122	const subscriptionAmount = zeroDecimalCurrencies.includes(currency) ? subscriptionAmountTotalInMinorUnits : subscriptionAmountTotal;
123
124	const isOneTime = donationType === 'single';
125	const isRecurring = donationType === 'subscription';
126
127	return {
128	firstName,
129	lastName,
130	email,
131	phone,
132	currency,
133	billingAddress,
134	amount: isOneTime ? donationAmount : subscriptionAmount,
135	amountInMinorUnits: isOneTime ? amountTotalInMinorUnits : subscriptionAmountTotalInMinorUnits,
136	isOneTime,
137	isRecurring,
138	subscriptionPeriod,
139	subscriptionFrequency,
140	subscriptionInstallments,
141	};
142	}
143