components
1 year ago
constants.ts
1 year ago
helpers.ts
1 year ago
index.tsx
1 year ago
style.scss
1 year ago
types.ts
1 year ago
helpers.ts
190 lines
| 1 | import analytics from '@automattic/jetpack-analytics'; |
| 2 | import { getRedirectUrl } from '@automattic/jetpack-components'; |
| 3 | import { dateI18n } from '@wordpress/date'; |
| 4 | import { SubscriberTotalsByDate, ChartSubscriptionDataPoint } from './types'; |
| 5 | |
| 6 | /** |
| 7 | * Creates an event handler function for tracking user interactions |
| 8 | * |
| 9 | * @param tracks - The tracks analytics object |
| 10 | * @param eventName - The "action" part of the event name. Will be appended to "jetpack_newsletter_widget_" |
| 11 | * @param eventProperties - Additional properties to include in the event |
| 12 | * @returns A callback function that records the event when triggered. To primarily be used as an onClick prop. |
| 13 | * |
| 14 | * @example |
| 15 | * const handleClick = createTracksEventHandler( tracks, 'learn_more_click', { locale: 'en' } ); |
| 16 | */ |
| 17 | export const createTracksEventHandler = ( |
| 18 | tracks: typeof analytics.tracks, |
| 19 | |
| 20 | eventAction: string, |
| 21 | |
| 22 | eventProperties: Record< string, unknown > = {} |
| 23 | ) => { |
| 24 | return () => { |
| 25 | tracks.recordEvent( `jetpack_newsletter_widget_${ eventAction }`, eventProperties ); |
| 26 | }; |
| 27 | }; |
| 28 | |
| 29 | /** |
| 30 | * Helper function to build the Jetpack redirect source URL. |
| 31 | * @param url - The url to redirect to. Note: it can only be to a whitelisted domain, and query params and anchors must be passed to getRedirectUrl as arguments. |
| 32 | * @param isWpcomSite - The the site on the WordPress.com platform. Simple or WoA. |
| 33 | * @return The URL that can be passed to the getRedirectUrl function. |
| 34 | * @example |
| 35 | * const site = 'example.wordpress.com'; |
| 36 | * const redirectUrl = buildJPRedirectSource( `subscribers/${ site }`, true ); |
| 37 | * |
| 38 | * <a href={ getRedirectUrl( redirectUrl ) }>Subscriber</a>; |
| 39 | */ |
| 40 | export const buildJPRedirectSource = ( url: string, isWpcomSite: boolean = true ) => { |
| 41 | const host = isWpcomSite ? 'wordpress.com' : 'cloud.jetpack.com'; |
| 42 | return `https://${ host }/${ url }`; |
| 43 | }; |
| 44 | |
| 45 | /** |
| 46 | * Generates the URL for subscriber statistics based on site context. |
| 47 | * |
| 48 | * @param {string} site - The site identifier |
| 49 | * @param {boolean} isWpcomSite - Whether the site is on WordPress.com |
| 50 | * @param {string} adminUrl - The admin URL for self-hosted sites |
| 51 | * @returns {string} The appropriate subscriber stats URL |
| 52 | */ |
| 53 | export const getSubscriberStatsUrl = ( |
| 54 | site: string, |
| 55 | isWpcomSite: boolean, |
| 56 | adminUrl: string |
| 57 | ): string => { |
| 58 | return isWpcomSite |
| 59 | ? getRedirectUrl( buildJPRedirectSource( `stats/subscribers/${ site }` ) ) |
| 60 | : `${ adminUrl }admin.php?page=stats#!/stats/subscribers/${ site }`; |
| 61 | }; |
| 62 | |
| 63 | /** |
| 64 | * Generates the URL for newsletter settings based on site context. |
| 65 | * |
| 66 | * @param {string} site - The site identifier |
| 67 | * @param {boolean} isWpcomSite - Whether the site is on WordPress.com |
| 68 | * @param {string} adminUrl - The admin URL for self-hosted sites |
| 69 | * @returns {string} The appropriate newsletter settings URL |
| 70 | */ |
| 71 | export const getNewsletterSettingsUrl = ( |
| 72 | site: string, |
| 73 | isWpcomSite: boolean, |
| 74 | adminUrl: string |
| 75 | ): string => { |
| 76 | return isWpcomSite |
| 77 | ? getRedirectUrl( buildJPRedirectSource( 'settings/newsletter/' + site ) ) |
| 78 | : `${ adminUrl }admin.php?page=jetpack#newsletter`; |
| 79 | }; |
| 80 | |
| 81 | /** |
| 82 | * Formats a number into a localized string representation. |
| 83 | * |
| 84 | * @param {number} num - The number to format. |
| 85 | * @returns {string} The formatted number string. |
| 86 | */ |
| 87 | export const formatNumber = ( num: number ): string => { |
| 88 | return num.toLocaleString(); |
| 89 | }; |
| 90 | |
| 91 | /** |
| 92 | * Formats a date into a string representation. |
| 93 | * |
| 94 | * @param {Date} date - The date to format. |
| 95 | * @param {'short' | 'full'} format - Format type: 'short' for "Jan 5" or 'full' for "Jan 5, 2023". |
| 96 | * @returns {string} The formatted date string. |
| 97 | */ |
| 98 | export const formatDate = ( date: Date, format: 'short' | 'full' = 'short' ) => { |
| 99 | if ( format === 'short' ) { |
| 100 | // 'M j' = Short month name followed by day number without leading zeros (e.g., "Jan 5") |
| 101 | return dateI18n( 'M j', date ); |
| 102 | } |
| 103 | |
| 104 | // 'M j, Y' = Short month name, day number without leading zeros, and year (e.g., "Jan 5, 2023") |
| 105 | return dateI18n( 'M j, Y', date ); |
| 106 | }; |
| 107 | |
| 108 | /** |
| 109 | * Formats a date specifically for axis tick labels. |
| 110 | * |
| 111 | * @param {Date} date - The date to format. |
| 112 | * @returns {string} The formatted date string in short format. |
| 113 | */ |
| 114 | export const formatAxisTickDate = ( date: Date ) => formatDate( date, 'short' ); |
| 115 | |
| 116 | /** |
| 117 | * Calculates evenly spaced tick values for the X-axis for time series data. |
| 118 | * Assumes the data is sorted by date, earliest is first. |
| 119 | * |
| 120 | * @param {ChartSubscriptionDataPoint[]} data - The subscription data array. |
| 121 | * @returns {Date[]} An array of dates representing tick positions at 0%, 25%, 50%, 75%, and 100% of the time range. |
| 122 | */ |
| 123 | export const getXAxisTickValues = ( data: ChartSubscriptionDataPoint[] ) => { |
| 124 | if ( data.length < 2 ) return data.map( d => d.date ); |
| 125 | |
| 126 | const firstDate = data[ 0 ].date; |
| 127 | const lastDate = data[ data.length - 1 ].date; |
| 128 | |
| 129 | // Calculate total time span in milliseconds |
| 130 | const timeSpan = lastDate.getTime() - firstDate.getTime(); |
| 131 | |
| 132 | return [ |
| 133 | firstDate, |
| 134 | new Date( firstDate.getTime() + timeSpan * 0.25 ), |
| 135 | new Date( firstDate.getTime() + timeSpan * 0.5 ), |
| 136 | new Date( firstDate.getTime() + timeSpan * 0.75 ), |
| 137 | lastDate, |
| 138 | ]; |
| 139 | }; |
| 140 | |
| 141 | /** |
| 142 | * Transforms daily subscription counts into a format for the visx chart package. |
| 143 | * |
| 144 | * @param {Record<string, DailySubscriptionStat>} countsByDay - Object mapping date strings to daily subscription counts. |
| 145 | * @returns {ChartSubscriptionDataPoint[]} An array of subscription statistics. |
| 146 | */ |
| 147 | export const transformData = ( |
| 148 | countsByDay: SubscriberTotalsByDate |
| 149 | ): ChartSubscriptionDataPoint[] => { |
| 150 | return Object.entries( countsByDay ) |
| 151 | .map( ( [ dateStr, counts ] ) => { |
| 152 | const date = new Date( dateStr ); |
| 153 | |
| 154 | if ( isNaN( date.getTime() ) ) { |
| 155 | return null; |
| 156 | } |
| 157 | |
| 158 | return { |
| 159 | date, |
| 160 | all: counts?.all ?? 0, |
| 161 | paid: counts?.paid ?? 0, |
| 162 | }; |
| 163 | } ) |
| 164 | .filter( Boolean ) |
| 165 | .sort( ( a, b ) => a.date.getTime() - b.date.getTime() ); |
| 166 | }; |
| 167 | |
| 168 | /** |
| 169 | * Calculates the maximum value of the subscription statistics to determine the left axis tick label margin. |
| 170 | * Larger labels will get cut off so we must dynamically increase the margin based on how many digits are in the largest number. |
| 171 | * |
| 172 | * @param {ChartSubscriptionDataPoint[]} subs - The subscription statistics array. The same data used to render the chart. |
| 173 | * @returns {number} The calculated left axis margin. |
| 174 | */ |
| 175 | export const calcLeftAxisMargin = ( subs: ChartSubscriptionDataPoint[] ): number => { |
| 176 | const DEFAULT_MARGIN = 30; |
| 177 | const CHAR_PX_WIDTH = 8; |
| 178 | const PADDING = 10; |
| 179 | |
| 180 | if ( subs.length === 0 ) { |
| 181 | return DEFAULT_MARGIN; |
| 182 | } |
| 183 | |
| 184 | const maxValue = Math.max( ...subs.map( d => Math.max( d.all || 0, d.paid || 0 ) ) ); |
| 185 | // Estimate character width (in pixels) and calculate margin |
| 186 | // Each digit is roughly 8px, plus add some padding |
| 187 | const digitCount = maxValue.toString().length; |
| 188 | return Math.max( DEFAULT_MARGIN, digitCount * CHAR_PX_WIDTH + PADDING ); |
| 189 | }; |
| 190 |