app/lib/pages/page-json-ld.ts

Functions

Imports

It imports app/lib/content-pages.mjs, app/lib/dictionary-entries.mjs, app/lib/pages/compile.mjs, app/lib/seo.ts. Imported by app/routes/content-page.tsx, app/routes/phages.tsx.

Source

1// The structured data a content page carries: its trail, its own node typed from the page, and its dictionary entry.
2// Shared by the research/* page route and the routes that draw a page's own piece themselves (the phage table).
3import type { PageRecord } from "~/lib/pages/compile.mjs";
4import { contentPageMarkdownPath } from "~/lib/content-pages.mjs";
5import { definedTermJsonLd, type DictionaryEntry as Entry } from "~/lib/dictionary-entries.mjs";
6import { LICENSE_URL, SITE, SITE_ORIGIN, breadcrumbJsonLd, personId } from "~/lib/seo";
7
8type ContentPage = PageRecord;
9
10/**
11 * The page's own node, typed from the page, so a WebSite is not emitted as an application. Each property
12 * is one the page's frontmatter or its markdown states; a fact the repo does not hold is left out, never
13 * filled in. A code repository belongs to SoftwareSourceCode in schema.org, so an application that has
14 * one gets a second node for its source, joined to it by targetProduct.
15 */
16function pageJsonLd(page: ContentPage): object[] {
17  if (!page.schemaType) return [];
18  const pageUrl = `${SITE_ORIGIN}${page.path}`;
19  const person = { "@type": "Person", "@id": personId(SITE_ORIGIN), name: SITE.name, url: SITE_ORIGIN };
20  const isDataset = page.schemaType === "Dataset";
21  const node = {
22    "@context": "https://schema.org",
23    "@type": page.schemaType,
24    "@id": `${pageUrl}#${page.schemaType.toLowerCase()}`,
25    // A dataset is named by what it holds; the page's short title ("Our phages") names the page.
26    name: isDataset ? page.seoTitle : page.title,
27    description: page.description,
28    url: page.productUrl ?? pageUrl,
29    ...(page.productUrl ? { mainEntityOfPage: pageUrl } : {}),
30    // A legal page's last-updated day, the one the page shows under its title.
31    ...(page.lastUpdated ? { dateModified: page.lastUpdated } : {}),
32    ...(isDataset ? { creator: person } : { author: person }),
33    ...(page.schemaType === "SoftwareSourceCode" && page.codeRepository
34      ? { codeRepository: page.codeRepository }
35      : {}),
36    ...(page.applicationCategory ? { applicationCategory: page.applicationCategory } : {}),
37    ...(page.programmingLanguage ? { programmingLanguage: page.programmingLanguage } : {}),
38    ...(page.runtimePlatform ? { runtimePlatform: page.runtimePlatform } : {}),
39    // A Dataset's license is the site's terms, whatever the page's frontmatter says, so none can be left out.
40    ...(isDataset ? { license: LICENSE_URL } : page.license ? { license: page.license } : {}),
41    ...(page.dataset
42      ? {
43          // Public on this page with no sign-in, which is all the property claims.
44          isAccessibleForFree: true,
45          variableMeasured: page.dataset.variableMeasured,
46          ...(page.dataset.temporalCoverage ? { temporalCoverage: page.dataset.temporalCoverage } : {}),
47          ...(page.spatialCoverage ? { spatialCoverage: { "@type": "Place", name: page.spatialCoverage } } : {}),
48          // The markdown twin carries the same table, so it is the download.
49          distribution: {
50            "@type": "DataDownload",
51            encodingFormat: "text/markdown",
52            contentUrl: `${SITE_ORIGIN}${contentPageMarkdownPath(page.path)}`,
53          },
54        }
55      : {}),
56  };
57  if (page.schemaType !== "SoftwareApplication" || !page.codeRepository) return [node];
58  return [
59    node,
60    {
61      "@context": "https://schema.org",
62      "@type": "SoftwareSourceCode",
63      "@id": `${pageUrl}#softwaresourcecode`,
64      name: page.title,
65      codeRepository: page.codeRepository,
66      author: person,
67      targetProduct: { "@id": node["@id"] },
68    },
69  ];
70}
71
72/** The page's structured data: the trail it shows, its own node or nodes, and its dictionary entry. */
73export function contentPageJsonLd(page: ContentPage, trail: Array<[string, string]>, entry: Entry | null) {
74  return [
75    // Only a trail the page shows: the visible one renders from two steps, and Google reads no fewer.
76    ...(trail.length >= 2 ? [breadcrumbJsonLd(SITE_ORIGIN, trail)] : []),
77    ...pageJsonLd(page),
78    ...(entry ? [definedTermJsonLd(entry, SITE_ORIGIN)] : []),
79  ];
80}
81