diff options
| author | Armand Philippot <git@armandphilippot.com> | 2022-05-13 22:41:39 +0200 |
|---|---|---|
| committer | Armand Philippot <git@armandphilippot.com> | 2022-05-13 22:41:39 +0200 |
| commit | fe2252ced2bb895e26179640553b5a6c02957d54 (patch) | |
| tree | 4da3258dc4cd1971f5c39ac2366bb43df776130c | |
| parent | 5f3799ee75b3ac5cffe726023d8e5df129b919dd (diff) | |
chore: add Topic pages
| -rw-r--r-- | src/pages/sujet/[slug].tsx | 244 | ||||
| -rw-r--r-- | src/services/graphql/topics.query.ts | 7 | ||||
| -rw-r--r-- | src/services/graphql/topics.ts | 135 |
3 files changed, 380 insertions, 6 deletions
diff --git a/src/pages/sujet/[slug].tsx b/src/pages/sujet/[slug].tsx new file mode 100644 index 0000000..22fb531 --- /dev/null +++ b/src/pages/sujet/[slug].tsx @@ -0,0 +1,244 @@ +import Heading from '@components/atoms/headings/heading'; +import { type BreadcrumbItem } from '@components/molecules/nav/breadcrumb'; +import PostsList, { type Post } from '@components/organisms/layout/posts-list'; +import LinksListWidget from '@components/organisms/widgets/links-list-widget'; +import PageLayout, { + type PageLayoutProps, +} from '@components/templates/page/page-layout'; +import { + getAllTopicsSlugs, + getTopicBySlug, + getTopicsPreview, + getTotalTopics, +} from '@services/graphql/topics'; +import { type Article, type PageLink, type Topic } from '@ts/types/app'; +import { loadTranslation, type Messages } from '@utils/helpers/i18n'; +import { + getLinksListItems, + getPageLinkFromRawData, + getPostMeta, +} from '@utils/helpers/pages'; +import useSettings from '@utils/hooks/use-settings'; +import { GetStaticPaths, GetStaticProps, NextPage } from 'next'; +import Head from 'next/head'; +import { useRouter } from 'next/router'; +import Script from 'next/script'; +import { ParsedUrlQuery } from 'querystring'; +import { useIntl } from 'react-intl'; +import { Article as ArticleSchema, Graph, WebPage } from 'schema-dts'; + +export type TopicPageProps = { + currentTopic: Topic; + topics: PageLink[]; + translation: Messages; +}; + +const TopicPage: NextPage<TopicPageProps> = ({ currentTopic, topics }) => { + const { content, intro, meta, slug, title } = currentTopic; + const { articles, dates, seo, thematics } = meta; + const intl = useIntl(); + const homeLabel = intl.formatMessage({ + defaultMessage: 'Home', + description: 'Breadcrumb: home label', + id: 'j5k9Fe', + }); + const blogLabel = intl.formatMessage({ + defaultMessage: 'Blog', + description: 'Breadcrumb: blog label', + id: 'Es52wh', + }); + const breadcrumb: BreadcrumbItem[] = [ + { id: 'home', name: homeLabel, url: '/' }, + { id: 'blog', name: blogLabel, url: '/blog' }, + { id: 'topic', name: title, url: `/sujet/${slug}` }, + ]; + + const headerMeta: PageLayoutProps['headerMeta'] = { + publication: { date: dates.publication }, + update: dates.update ? { date: dates.update } : undefined, + }; + + const { website } = useSettings(); + const { asPath } = useRouter(); + const pageUrl = `${website.url}${asPath}`; + const pagePublicationDate = new Date(dates.publication); + const pageUpdateDate = dates.update ? new Date(dates.update) : undefined; + + const webpageSchema: WebPage = { + '@id': `${pageUrl}`, + '@type': 'WebPage', + breadcrumb: { '@id': `${website.url}/#breadcrumb` }, + name: seo.title, + description: seo.description, + inLanguage: website.locales.default, + reviewedBy: { '@id': `${website.url}/#branding` }, + url: `${website.url}`, + }; + + const articleSchema: ArticleSchema = { + '@id': `${website.url}/#topic`, + '@type': 'Article', + name: title, + description: intro, + author: { '@id': `${website.url}/#branding` }, + copyrightYear: pagePublicationDate.getFullYear(), + creator: { '@id': `${website.url}/#branding` }, + dateCreated: pagePublicationDate.toISOString(), + dateModified: pageUpdateDate && pageUpdateDate.toISOString(), + datePublished: pagePublicationDate.toISOString(), + editor: { '@id': `${website.url}/#branding` }, + headline: title, + inLanguage: website.locales.default, + isPartOf: { '@id': `${website.url}/blog` }, + license: 'https://creativecommons.org/licenses/by-sa/4.0/deed.fr', + mainEntityOfPage: { '@id': `${pageUrl}` }, + subjectOf: { '@id': `${website.url}/blog` }, + }; + + const schemaJsonLd: Graph = { + '@context': 'https://schema.org', + '@graph': [webpageSchema, articleSchema], + }; + + const getPosts = (array: Article[]): Post[] => { + return array.map((article) => { + const { + intro: articleIntro, + meta: articleMeta, + slug: articleSlug, + ...remainingData + } = article; + + const { cover, ...remainingMeta } = articleMeta; + + return { + cover, + excerpt: articleIntro, + meta: getPostMeta(remainingMeta), + url: `/article/${articleSlug}`, + ...remainingData, + }; + }); + }; + + const topicsListTitle = intl.formatMessage({ + defaultMessage: 'Other topics', + description: 'TopicPage: other topics list widget title', + id: 'JpC3JH', + }); + + const thematicsListTitle = intl.formatMessage({ + defaultMessage: 'Related thematics', + description: 'TopicPage: related thematics list widget title', + id: '/sRqPT', + }); + + return ( + <> + <Head> + <title>{seo.title}</title> + <meta name="description" content={seo.description} /> + <meta property="og:url" content={`${pageUrl}`} /> + <meta property="og:type" content="article" /> + <meta property="og:title" content={title} /> + <meta property="og:description" content={intro} /> + </Head> + <Script + id="schema-project" + type="application/ld+json" + dangerouslySetInnerHTML={{ __html: JSON.stringify(schemaJsonLd) }} + /> + <PageLayout + breadcrumb={breadcrumb} + title={title} + intro={intro} + headerMeta={headerMeta} + widgets={ + thematics + ? [ + <LinksListWidget + key="related-thematics" + items={getLinksListItems(thematics, 'thematic')} + title={thematicsListTitle} + level={2} + />, + <LinksListWidget + key="topics" + items={getLinksListItems(topics, 'topic')} + title={topicsListTitle} + level={2} + />, + ] + : [] + } + > + <div dangerouslySetInnerHTML={{ __html: content }} /> + {articles && ( + <> + <Heading level={2}> + {intl.formatMessage( + { + defaultMessage: 'All posts in {topicName}', + description: 'TopicPage: posts list heading', + id: 'zEN3fd', + }, + { topicName: title } + )} + </Heading> + <PostsList + posts={getPosts(articles)} + total={articles.length} + titleLevel={3} + byYear={true} + /> + </> + )} + </PageLayout> + </> + ); +}; + +interface TopicParams extends ParsedUrlQuery { + slug: string; +} + +export const getStaticProps: GetStaticProps<TopicPageProps> = async ({ + locale, + params, +}) => { + const currentTopic = await getTopicBySlug( + params!.slug as TopicParams['slug'] + ); + const totalTopics = await getTotalTopics(); + const allTopicsEdges = await getTopicsPreview({ + first: totalTopics, + }); + const allTopics = allTopicsEdges.edges.map((edge) => + getPageLinkFromRawData(edge.node) + ); + const translation = await loadTranslation(locale); + + return { + props: { + currentTopic: JSON.parse(JSON.stringify(currentTopic)), + topics: allTopics.filter( + (topic) => topic.slug !== (params!.slug as TopicParams['slug']) + ), + translation, + }, + }; +}; + +export const getStaticPaths: GetStaticPaths = async () => { + const slugs = await getAllTopicsSlugs(); + const paths = slugs.map((slug) => { + return { params: { slug } }; + }); + + return { + paths, + fallback: false, + }; +}; + +export default TopicPage; diff --git a/src/services/graphql/topics.query.ts b/src/services/graphql/topics.query.ts index 6cc525e..19be5d7 100644 --- a/src/services/graphql/topics.query.ts +++ b/src/services/graphql/topics.query.ts @@ -16,6 +16,13 @@ export const topicBySlugQuery = `query TopicBy($slug: ID!) { } } } + author { + node { + gravatarUrl + name + url + } + } commentCount contentParts { beforeMore diff --git a/src/services/graphql/topics.ts b/src/services/graphql/topics.ts index 0f59bad..3c92442 100644 --- a/src/services/graphql/topics.ts +++ b/src/services/graphql/topics.ts @@ -1,6 +1,20 @@ -import { RawTopicPreview, TotalItems } from '@ts/types/raw-data'; +import { PageLink, Slug, Topic } from '@ts/types/app'; +import { + RawArticle, + RawTopic, + RawTopicPreview, + TotalItems, +} from '@ts/types/raw-data'; +import { getImageFromRawData } from '@utils/helpers/images'; +import { getPageLinkFromRawData } from '@utils/helpers/pages'; import { EdgesResponse, EdgesVars, fetchAPI, getAPIUrl } from './api'; -import { topicsListQuery, totalTopicsQuery } from './topics.query'; +import { getArticleFromRawData } from './articles'; +import { + topicBySlugQuery, + topicsListQuery, + topicsSlugQuery, + totalTopicsQuery, +} from './topics.query'; /** * Retrieve the total number of topics. @@ -34,9 +48,118 @@ export const getTopicsPreview = async ( return response.topics; }; -export const getAllTopicsLinks = async () => { - const allTopics = []; - const initialTopics = await getTopicsPreview({ first: 1 }); +/** + * Convert raw data to a Topic object. + * + * @param {RawTopic} data - The page raw data. + * @returns {Topic} The page data. + */ +export const getTopicFromRawData = (data: RawTopic): Topic => { + const { + acfTopics, + contentParts, + databaseId, + date, + featuredImage, + info, + modified, + slug, + title, + seo, + } = data; + + /** + * Retrieve an array of related topics. + * + * @param posts - The topic posts. + * @returns {PageLink[]} An array of topics links. + */ + const getRelatedThematics = (posts: RawArticle[]): PageLink[] => { + const thematics: PageLink[] = []; + + posts.forEach((post) => { + if (post.acfPosts.postsInThematic) { + post.acfPosts.postsInThematic.forEach((thematic) => + thematics.push(getPageLinkFromRawData(thematic)) + ); + } + }); + + const thematicsIds = thematics.map((thematic) => thematic.id); + const uniqueThematics = thematics.filter( + ({ id }, index) => !thematicsIds.includes(id, index + 1) + ); + const sortThematicByName = (a: PageLink, b: PageLink) => { + var nameA = a.name.toUpperCase(); // ignore upper and lowercase + var nameB = b.name.toUpperCase(); // ignore upper and lowercase + if (nameA < nameB) { + return -1; + } + if (nameA > nameB) { + return 1; + } + + // names must be equal + return 0; + }; + + return uniqueThematics.sort(sortThematicByName); + }; + + return { + content: contentParts.afterMore, + id: databaseId, + intro: contentParts.beforeMore, + meta: { + articles: acfTopics.postsInTopic.map((post) => + getArticleFromRawData(post) + ), + cover: featuredImage?.node + ? getImageFromRawData(featuredImage.node) + : undefined, + dates: { publication: date, update: modified }, + website: acfTopics.officialWebsite, + readingTime: info.readingTime, + seo: { + description: seo?.metaDesc || '', + title: seo?.title || '', + }, + thematics: getRelatedThematics(acfTopics.postsInTopic), + wordsCount: info.wordsCount, + }, + slug, + title, + }; +}; + +/** + * Retrieve a Topic object by slug. + * + * @param {string} slug - The topic slug. + * @returns {Promise<Article>} The requested topic. + */ +export const getTopicBySlug = async (slug: string): Promise<Topic> => { + const response = await fetchAPI<RawTopic, typeof topicBySlugQuery>({ + api: getAPIUrl(), + query: topicBySlugQuery, + variables: { slug }, + }); + + return getTopicFromRawData(response.topic); +}; + +/** + * Retrieve all the topics slugs. + * + * @returns {Promise<string[]>} - An array of topics slugs. + */ +export const getAllTopicsSlugs = async (): Promise<string[]> => { + const totalTopics = await getTotalTopics(); + const response = await fetchAPI<Slug, typeof topicsSlugQuery>({ + api: getAPIUrl(), + query: topicsSlugQuery, + variables: { first: totalTopics }, + }); - if (!initialTopics.pageInfo.hasNextPage) return initialTopics; + return response.topics.edges.map((edge) => edge.node.slug); }; |
