index : www.armandphilippot.com	main
	The frontend of my personal website.	Armand Philippot

aboutsummaryrefslogtreecommitdiffstats

log msg author committer range

path: root/src/components/MetaItems/Topics

	Commit message (Collapse)	Author	Age	Files	Lines
*	refactor: use formatjs swc plugin	Armand Philippot	2022-03-23	1	-0/+1
| | | | |	I'm not able to configure SWC plugins in Next.js so to make it works, all translation must have an id.
*	refactor: split posts meta into smaller components	Armand Philippot	2022-03-01	1	-0/+36

generated by cgit v1.2.3 (git 2.39.1) at 2025-10-29 23:25:12 +0000

import { Dates } from '@ts/types/app';
import { settings } from '@utils/config';
import {
  AboutPage,
  Article,
  Blog,
  BlogPosting,
  ContactPage,
  Graph,
  WebPage,
} from 'schema-dts';

export type GetBlogSchemaProps = {
  /**
   * True if the page is part of the blog.
   */
  isSinglePage: boolean;
  /**
   * The page locale.
   */
  locale: string;
  /**
   * The page slug with a leading slash.
   */
  slug: string;
};

/**
 * Retrieve the JSON for Blog schema.
 *
 * @param props - The page data.
 * @returns {Blog} The JSON for Blog schema.
 */
export const getBlogSchema = ({
  isSinglePage,
  locale,
  slug,
}: GetBlogSchemaProps): Blog => {
  return {
    '@id': `${settings.url}/#blog`,
    '@type': 'Blog',
    author: { '@id': `${settings.url}/#branding` },
    creator: { '@id': `${settings.url}/#branding` },
    editor: { '@id': `${settings.url}/#branding` },
    blogPost: isSinglePage ? { '@id': `${settings.url}/#article` } : undefined,
    inLanguage: locale,
    isPartOf: isSinglePage
      ? {
          '@id': `${settings.url}${slug}`,
        }
      : undefined,
    license: 'https://creativecommons.org/licenses/by-sa/4.0/deed.fr',
    mainEntityOfPage: isSinglePage
      ? undefined
      : { '@id': `${settings.url}${slug}` },
  };
};

export type SinglePageSchemaReturn = {
  about: AboutPage;
  contact: ContactPage;
  page: Article;
  post: BlogPosting;
};

export type SinglePageSchemaKind = keyof SinglePageSchemaReturn;

export type GetSinglePageSchemaProps<T extends SinglePageSchemaKind> = {
  /**
   * The number of comments.
   */
  commentsCount?: number;
  /**
   * The page content.
   */
  content?: string;
  /**
   * The url of the cover.
   */
  cover?: string;
  /**
   * The page dates.
   */
  dates: Dates;
  /**
   * The page description.
   */
  description: string;
  /**
   * The page id.
   */
  id: string;
  /**
   * The page kind.
   */
  kind: T;
  /**
   * The page locale.
   */
  locale: string;
  /**
   * The page slug with a leading slash.
   */
  slug: string;
  /**
   * The page title.
   */
  title: string;
};

/**
 * Retrieve the JSON schema depending on the page kind.
 *
 * @param props - The page data.
 * @returns {SinglePageSchemaReturn[T]} - Either AboutPage, ContactPage, Article or BlogPosting schema.
 */
export const getSinglePageSchema = <T extends SinglePageSchemaKind>({
  commentsCount,
  content,
  cover,
  dates,
  description,
  id,
  kind,
  locale,
  title,
  slug,
}: GetSinglePageSchemaProps<T>): SinglePageSchemaReturn[T] => {
  const publicationDate = new Date(dates.publication);
  const updateDate = dates.update ? new Date(dates.update) : undefined;
  const singlePageSchemaType = {
    about: 'AboutPage',
    contact: 'ContactPage',
    page: 'Article',
    post: 'BlogPosting',
  };

  return {
    '@id': `${settings.url}/#${id}`,
    '@type': singlePageSchemaType[kind],
    name: title,
    description,
    articleBody: content,
    author: { '@id': `${settings.url}/#branding` },
    commentCount: commentsCount,
    copyrightYear: publicationDate.getFullYear(),
    creator: { '@id': `${settings.url}/#branding` },
    dateCreated: publicationDate.toISOString(),
    dateModified: updateDate && updateDate.toISOString(),
    datePublished: publicationDate.toISOString(),
    editor: { '@id': `${settings.url}/#branding` },
    headline: title,
    image: cover,
    inLanguage: locale,
    license: 'https://creativecommons.org/licenses/by-sa/4.0/deed.fr',
    thumbnailUrl: cover,
    isPartOf:
      kind === 'post'
        ? {
            '@id': `${settings.url}/blog`,
          }
        : undefined,
    mainEntityOfPage: { '@id': `${settings.url}${slug}` },
  } as SinglePageSchemaReturn[T];
};

export type GetWebPageSchemaProps = {
  /**
   * The page description.
   */
  description: string;
  /**
   * The page locale.
   */
  locale: string;
  /**
   * The page slug.
   */
  slug: string;
  /**
   * The page title.
   */
  title: string;
  /**
   * The page last update.
   */
  updateDate?: string;
};

/**
 * Retrieve the JSON for WebPage schema.
 *
 * @param props - The page data.
 * @returns {WebPage} The JSON for WebPage schema.
 */
export const getWebPageSchema = ({
  description,
  locale,
  slug,
  title,
  updateDate,
}: GetWebPageSchemaProps): WebPage => {
  return {
    '@id': `${settings.url}${slug}`,
    '@type': 'WebPage',
    breadcrumb: { '@id': `${settings.url}/#breadcrumb` },
    lastReviewed: updateDate,
    name: title,
    description: description,
    inLanguage: locale,
    reviewedBy: { '@id': `${settings.url}/#branding` },
    url: `${settings.url}${slug}`,
    isPartOf: {
      '@id': `${settings.url}`,
    },
  };
};

export const getSchemaJson = (graphs: Graph['@graph']): Graph => {
  return {
    '@context': 'https://schema.org',
    '@graph': graphs,
  };
};