give
/
src
/
Subscriptions
/
resources
/
admin
/
components
/
SubscriptionDetailsPage
/
Tabs
/
Overview
/
SubscriptionSummary
/
index.tsx
give
/
src
/
Subscriptions
/
resources
/
admin
/
components
/
SubscriptionDetailsPage
/
Tabs
/
Overview
/
SubscriptionSummary
Last commit date
index.tsx
10 months ago
styles.module.scss
11 months ago
index.tsx
127 lines
| 1 | import {Header, OverviewPanel, SummaryItem, SummaryTable} from '@givewp/admin/components'; |
| 2 | import {amountFormatter} from '@givewp/src/Admin/utils'; |
| 3 | import {Subscription} from '@givewp/subscriptions/admin/components/types'; |
| 4 | import {dateI18n} from '@wordpress/date'; |
| 5 | import {__} from '@wordpress/i18n'; |
| 6 | import styles from './styles.module.scss'; |
| 7 | import {getSubscriptionEmbeds} from '@givewp/subscriptions/common'; |
| 8 | |
| 9 | |
| 10 | /** |
| 11 | * Calculates the end date of a subscription based on its billing parameters. |
| 12 | * |
| 13 | * The calculation uses the formula: End Date = Start Date + (Installments - 1) × Frequency × Period |
| 14 | * |
| 15 | * For example: |
| 16 | * - A monthly subscription with 12 installments: Start Date + 11 months |
| 17 | * - A weekly subscription with 4 installments: Start Date + 3 weeks |
| 18 | * - A yearly subscription with 5 installments: Start Date + 4 years |
| 19 | * |
| 20 | * @param subscription - The subscription object containing billing parameters |
| 21 | * @returns ISO string of the calculated end date, or null if calculation is not possible |
| 22 | * |
| 23 | * @since 4.8.0 |
| 24 | */ |
| 25 | const calculateEndDate = (subscription: Subscription): string | null => { |
| 26 | if (!subscription) { |
| 27 | return null; |
| 28 | } |
| 29 | |
| 30 | // If installments is 0, the subscription is ongoing (no end date) |
| 31 | if (subscription.installments === 0) { |
| 32 | return null; |
| 33 | } |
| 34 | |
| 35 | const startDate = new Date(subscription.createdAt); |
| 36 | const period = subscription.period; // day, week, month, quarter, year |
| 37 | const frequency = subscription.frequency; // how many periods between each payment |
| 38 | const installments = subscription.installments; // total number of payments |
| 39 | |
| 40 | // Calculate total periods to add: (installments - 1) × frequency |
| 41 | // We subtract 1 from installments because the first payment is on the start date |
| 42 | const totalPeriods = (installments - 1) * frequency; |
| 43 | |
| 44 | const endDate = new Date(startDate); |
| 45 | |
| 46 | // Add the calculated periods based on the billing period type |
| 47 | switch (period) { |
| 48 | case 'day': |
| 49 | endDate.setDate(endDate.getDate() + totalPeriods); |
| 50 | break; |
| 51 | case 'week': |
| 52 | endDate.setDate(endDate.getDate() + totalPeriods * 7); |
| 53 | break; |
| 54 | case 'month': |
| 55 | endDate.setMonth(endDate.getMonth() + totalPeriods); |
| 56 | break; |
| 57 | case 'quarter': |
| 58 | endDate.setMonth(endDate.getMonth() + totalPeriods * 3); |
| 59 | break; |
| 60 | case 'year': |
| 61 | endDate.setFullYear(endDate.getFullYear() + totalPeriods); |
| 62 | break; |
| 63 | default: |
| 64 | return null; |
| 65 | } |
| 66 | |
| 67 | return endDate.toISOString(); |
| 68 | }; |
| 69 | |
| 70 | /** |
| 71 | * @since 4.8.0 |
| 72 | */ |
| 73 | interface SummaryProps { |
| 74 | subscription: Subscription; |
| 75 | intendedAmount: number; |
| 76 | adminUrl: string; |
| 77 | isLoading: boolean; |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * @since 4.10.0 removed donation from props |
| 82 | * @since 4.8.0 |
| 83 | */ |
| 84 | export default function Summary({subscription, adminUrl, intendedAmount, isLoading}: SummaryProps) { |
| 85 | const {form} = getSubscriptionEmbeds(subscription); |
| 86 | const formTitle = form?.title ?? __('Donation Form', 'give'); |
| 87 | const endDate = calculateEndDate(subscription); |
| 88 | |
| 89 | const summaryItems: SummaryItem[] = [ |
| 90 | { |
| 91 | label: __('Start date', 'give'), |
| 92 | value: dateI18n('jS M, Y', subscription?.createdAt, undefined), |
| 93 | }, |
| 94 | { |
| 95 | label: __('End date', 'give'), |
| 96 | value: endDate ? dateI18n('jS M, Y', endDate, undefined) : __('Ongoing', 'give'), |
| 97 | }, |
| 98 | { |
| 99 | label: __('Donation form', 'give'), |
| 100 | value: subscription?.donationFormId ? ( |
| 101 | <a |
| 102 | className={styles.link} |
| 103 | href={`${adminUrl}edit.php?post_type=give_forms&page=givewp-form-builder&donationFormID=${subscription?.donationFormId}`} |
| 104 | target="_blank" |
| 105 | rel="noopener noreferrer" |
| 106 | > |
| 107 | {formTitle} |
| 108 | </a> |
| 109 | ) : '', |
| 110 | }, |
| 111 | { |
| 112 | label: __('Renewal', 'give'), |
| 113 | value: amountFormatter(subscription?.amount?.currency).format(intendedAmount), |
| 114 | }, |
| 115 | ]; |
| 116 | |
| 117 | return ( |
| 118 | <OverviewPanel className={styles.summaryPanel}> |
| 119 | <Header |
| 120 | title={__('Summary', 'give')} |
| 121 | subtitle={__('Information about the initial recurring donation', 'give')} |
| 122 | /> |
| 123 | <SummaryTable data={summaryItems} isLoading={isLoading} /> |
| 124 | </OverviewPanel> |
| 125 | ); |
| 126 | } |
| 127 |