wp-calypso/client/my-sites/stats/hooks/use-stats-strings.tsx

import { isEnabled } from '@automattic/calypso-config';
import { localizeUrl } from '@automattic/i18n-utils';
import { Substitution, useTranslate } from 'i18n-calypso';
import { useMemo } from 'react';
import InlineSupportLink from 'calypso/components/inline-support-link';
import { SUPPORT_URL, INSIGHTS_SUPPORT_URL, JETPACK_SUPPORT_URL_TRAFFIC } from '../const';

type StatsStringsConfig = {
	supportsArchiveStats: boolean;
	isSiteJetpackNotAtomic: boolean;
};

export default function useStatsStrings( {
	supportsArchiveStats = false,
	isSiteJetpackNotAtomic = false,
}: Partial< StatsStringsConfig > = {} ) {
	const translate = useTranslate();

	const isArchiveBreakdownFlag = isEnabled( 'stats/archive-breakdown' );
	const isArchiveBreakdownEnabled = isArchiveBreakdownFlag && supportsArchiveStats;

	const statsStrings = useMemo( () => {
		const strings: Record<
			string,
			{
				title: string;
				[ key: string ]: Substitution;
			}
		> = {};

		strings.posts = {
			title: isArchiveBreakdownEnabled
				? translate( 'Most viewed', { context: 'Stats: title of module', textOnly: true } )
				: translate( 'Posts & pages', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Title', { context: 'Stats: module row header for post title.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of post views.',
			} ),
			empty: translate(
				'Your most popular {{link}}posts and pages{{/link}} will display here once readers visit your site.',
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<a
								target="_blank"
								rel="noreferrer"
								href={ localizeUrl( `${ SUPPORT_URL }#posts-amp-pages` ) }
							/>
						),
					},
					context: 'Stats: Info box label when the Posts & Pages module is empty',
				}
			),
		};

		strings.referrers = {
			title: translate( 'Referrers', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Referrer', { context: 'Stats: module row header for post referrer.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of post views by referrer.',
			} ),
			empty: translate(
				"We'll show you which websites are {{link}}referring visitors{{/link}} to your site.",
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<a
								target="_blank"
								rel="noreferrer"
								href={ localizeUrl( `${ SUPPORT_URL }#referrers` ) }
							/>
						),
					},
					context: 'Stats: Info box label when the Referrers module is empty',
				}
			),
		};

		strings.clicks = {
			title: translate( 'Clicks', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Link', { context: 'Stats: module row header for links in posts.' } ),
			value: translate( 'Clicks', {
				context: 'Stats: module row header for number of clicks on a given link in a post.',
			} ),
			empty: translate( 'Your most {{link}}clicked external links{{/link}} will display here.', {
				comment: '{{link}} links to support documentation.',
				components: {
					link: (
						<a target="_blank" rel="noreferrer" href={ localizeUrl( `${ SUPPORT_URL }#clicks` ) } />
					),
				},
				context: 'Stats: Info box label when the Clicks module is empty',
			} ),
		};

		strings.countries = {
			title: translate( 'Countries', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Country', { context: 'Stats: module row header for views by country.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views from a country.',
			} ),
			empty: translate(
				'Stats on visitors and {{link}}their viewing location{{/link}} will appear here.',
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<InlineSupportLink
								supportContext={
									isSiteJetpackNotAtomic ? 'stats-countries-jetpack' : 'stats-countries'
								}
								showIcon={ false }
							/>
						),
					},
					context: 'Stats: Info box label when the Countries module is empty',
				}
			),
		};

		strings.locations = {
			title: translate( 'Locations', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Location', {
				context: 'Stats: module row header for views by country, region or city.',
			} ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views from a country, region or city.',
			} ),
			empty: translate(
				'Stats on visitors and {{link}}their viewing location{{/link}} will appear here.',
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<a
								target="_blank"
								rel="noreferrer"
								href={ localizeUrl( `${ SUPPORT_URL }#countries` ) }
							/>
						),
					},
					context: 'Stats: Info box label when the Locations module is empty',
				}
			),
		};

		strings.utm = {
			title: translate( 'UTM', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'UTM', { context: 'Stats: module row header for UTM module.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views per UTM.',
			} ),
			empty: translate(
				'If you use UTM codes, your {{link}}campaign performance data{{/link}} will show here.',
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<a
								target="_blank"
								rel="noreferrer"
								href={ localizeUrl( `${ JETPACK_SUPPORT_URL_TRAFFIC }#utm-stats` ) }
							/>
						),
					},
					context: 'Stats: Info box label when the UTM module is empty',
				}
			),
		};

		strings.search = {
			title: translate( 'Search terms', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Search term', {
				context: 'Stats: module row header for search in search terms.',
			} ),
			value: translate( 'Views', {
				context: 'Stats: module row header for views of a given search in search terms.',
			} ),
			empty: translate(
				'See {{link}}terms that visitors search{{/link}} to find your site, here. ',
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<a
								target="_blank"
								rel="noreferrer"
								href={ localizeUrl( `${ SUPPORT_URL }#search-terms` ) }
							/>
						),
					},
					context: 'Stats: Info box label when the Search Terms module is empty',
				}
			),
		};

		strings.authors = {
			title: translate( 'Authors', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Author', { context: 'Stats: module row header for authors.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views per author.',
			} ),
			empty: translate( '{{link}}Traffic that authors have generated{{/link}} will show here.', {
				comment: '{{link}} links to support documentation.',
				components: {
					link: (
						<a
							target="_blank"
							rel="noreferrer"
							href={ localizeUrl( `${ SUPPORT_URL }#authors` ) }
						/>
					),
				},
				context: 'Stats: Info box label when the Authors module is empty',
			} ),
		};

		strings.videoplays = {
			title: translate( 'Videos', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Video', { context: 'Stats: module row header for videos.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views per video.',
			} ),
			empty: translate( 'Your most viewed {{link}}video stats{{/link}} will show up here.', {
				comment: '{{link}} links to support documentation.',
				components: {
					link: (
						<a target="_blank" rel="noreferrer" href={ localizeUrl( `${ SUPPORT_URL }#videos` ) } />
					),
				},
				context: 'Stats: Info box label when the Videos module is empty',
			} ),
		};

		strings.filedownloads = {
			title: translate( 'File downloads', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Files', { context: 'Stats: module row header for file downloads.' } ),
			value: translate( 'downloads', {
				context: 'Stats: module row header for number of downloads per file.',
			} ),
			empty: translate( 'Stats from any {{link}}downloaded files{{/link}} will display here.', {
				comment: '{{link}} links to support documentation.',
				components: {
					link: (
						<a
							target="_blank"
							rel="noreferrer"
							href={ localizeUrl( `${ SUPPORT_URL }#file-downloads` ) }
						/>
					),
				},
				context: 'Stats: Info box label when the file downloads module is empty',
			} ),
		};

		strings.tags = {
			title: translate( 'Tags & categories', {
				context: 'Stats: title of module',
				textOnly: true,
			} ),
			item: translate( 'Topic', { context: 'Stats: module row header for tags and categories.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views per tag or category.',
			} ),
			empty: translate( 'Most viewed {{link}}tags & categories{{/link}} will be listed here.', {
				comment: '{{link}} links to support documentation.',
				components: {
					link: (
						<a
							target="_blank"
							rel="noreferrer"
							href={ localizeUrl( `${ INSIGHTS_SUPPORT_URL }#:~:text=Tags%20,%20Categories` ) }
						/>
					),
				},
				context: 'Stats: Info box label when the Tags module is empty',
			} ),
		};

		strings.publicize = {
			title: translate( 'Publicize', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Service', { context: 'Stats: module row header for publicize service.' } ),
			value: translate( 'Subscribers', {
				context: 'Stats: module row header for number of subscribers on the service.',
			} ),
			empty: translate( 'No publicize subscribers recorded', {
				context: 'Stats: Info box label when the publicize module is empty',
			} ),
		};

		strings.emails = {
			title: translate( 'Emails', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Title', { context: 'Stats: module row header for post title.' } ),
			value: translate( 'Opens', {
				context: 'Stats: module row header for number of email opens.',
			} ),
			empty: translate( 'Stats from {{link}}your emails{{/link}} will display here.', {
				comment: '{{link}} links to support documentation.',
				components: {
					link: (
						<a target="_blank" rel="noreferrer" href={ localizeUrl( `${ SUPPORT_URL }#emails` ) } />
					),
				},
				context: 'Stats: Info box label when the Email Open module is empty',
			} ),
		};

		strings.emailsClickStats = {
			title: translate( 'Email clicks', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Title', { context: 'Stats: module row header for post title.' } ),
			value: translate( 'Clicks', {
				context: 'Stats: module row header for number of email clicks.',
			} ),
			empty: translate( 'No email clicks', {
				context: 'Stats: Info box label when the Email Click module is empty',
			} ),
		};

		strings.devices = {
			title: translate( 'Devices', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Device', { context: 'Stats: module row header for views by country.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views from a country.',
			} ),
			empty: translate(
				'Stats on visitors and {{link}}their viewing device{{/link}} will appear here.',
				{
					comment: '{{link}} links to support documentation.',
					components: {
						link: (
							<InlineSupportLink
								supportContext={
									isSiteJetpackNotAtomic ? 'stats-devices-jetpack' : 'stats-devices'
								}
								showIcon={ false }
							/>
						),
					},
					context: 'Stats: Info box label when the Devices module is empty',
				}
			),
		};

		strings.clients = {
			title: translate( 'Clients', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Client', { context: 'Stats: module row header for views by country.' } ),
			value: translate( 'Views', {
				context: 'Stats: module row header for number of views from a country.',
			} ),
			empty: translate( 'No clients recorded', {
				context: 'Stats: Info box label when the Email clients module is empty',
			} ),
		};

		strings.links = {
			title: translate( 'Links', { context: 'Stats: title of module', textOnly: true } ),
			item: translate( 'Link', { context: 'Stats: module row header for links in posts.' } ),
			value: translate( 'Clicks', {
				context: 'Stats: module row header for number of clicks on a given link in a post.',
			} ),
			empty: translate( 'No links recorded', {
				context: 'Stats: Info box label when the Links module is empty',
			} ),
		};

		return strings;
	}, [ isArchiveBreakdownEnabled, translate, isSiteJetpackNotAtomic ] );

	return statsStrings;
}