app/lib/publications/article-json-ld.mjs

Functions

Imports

It imports app/lib/publications/entities.mjs. Imported by app/lib/seo.ts, app/routes/publications.$slug.tsx.

Source

1// The schema type comes from the curated type field, never the journal name. Only the owner's author
2// entry becomes an @id reference: replacing the array would drop up to 143 co-authors.
3
4import { decodeEntities } from "./entities.mjs";
5
6// abstract is still a ScholarlyArticle: hiding abstracts on the site is editorial, not a claim about them.
7const SCHEMA_TYPE = {
8  article: "ScholarlyArticle",
9  review: "ScholarlyArticle",
10  abstract: "ScholarlyArticle",
11  chapter: "Chapter",
12  "teaching-resource": "LearningResource",
13};
14
15/** @param {string} type @returns {string} */
16export function schemaTypeFor(type) {
17  // Falls back, never throws: types and check:machine-readable enforce the vocabulary, and a throw
18  // would fail a page render.
19  return SCHEMA_TYPE[/** @type {keyof typeof SCHEMA_TYPE} */ (type)] ?? "ScholarlyArticle";
20}
21
22/**
23 * Its own shape rather than Publication, so this stays .mjs for the build scripts; not `object`,
24 * because checkJs rejects every property access on one.
25 *
26 * @typedef {object} PaperFacts
27 * @property {string} title
28 * @property {string[]} authors
29 * @property {number | null} year
30 * @property {string | null} [publishedDate]
31 * @property {string | null} [journal]
32 * @property {string | null} [volume]
33 * @property {string | null} [issue]
34 * @property {string | null} [firstPage]
35 * @property {string | null} [lastPage]
36 * @property {string | null} [abstract]
37 * @property {string | null} [doi]
38 * @property {string} type
39 * @property {boolean} [isOpenAccess]
40 * @property {string | null} [license]
41 */
42
43/**
44 * @param {PaperFacts} paper
45 * @param {object} context
46 * @param {string} context.origin
47 * @param {string} context.pageUrl absolute URL of this paper's page
48 * @param {string | null} [context.pdfUrl] absolute URL of the hosted PDF
49 * @param {(name: string) => boolean} context.isOwner
50 * @param {string} context.personId
51 * @param {unknown} context.personNode
52 * @param {{ id: string, label: string }[]} [context.topics] resolved topic labels
53 */
54export function paperJsonLd(paper, context) {
55  const authors = (paper.authors ?? []).map((/** @type {string} */ name) =>
56    context.isOwner(name)
57      ? { "@id": context.personId }
58      : { "@type": "Person", name: decodeEntities(name) },
59  );
60
61  const article = {
62    "@context": "https://schema.org",
63    "@type": schemaTypeFor(paper.type),
64    "@id": context.pageUrl,
65    headline: decodeEntities(paper.title),
66    name: decodeEntities(paper.title),
67    author: authors,
68    // Deposited precision: a partial ISO date, so a record that only said 2011 says 2011.
69    datePublished: paper.publishedDate ?? (paper.year ? String(paper.year) : undefined),
70    url: context.pageUrl,
71    mainEntityOfPage: context.pageUrl,
72    ...(paper.doi
73      ? {
74          identifier: { "@type": "PropertyValue", propertyID: "DOI", value: paper.doi },
75          sameAs: `https://doi.org/${paper.doi}`,
76        }
77      : {}),
78    ...(paper.journal
79      ? {
80          isPartOf: {
81            "@type": "Periodical",
82            name: decodeEntities(paper.journal),
83            ...(paper.volume
84              ? {
85                  hasPart: {
86                    "@type": "PublicationVolume",
87                    volumeNumber: String(paper.volume),
88                    ...(paper.issue
89                      ? { hasPart: { "@type": "PublicationIssue", issueNumber: String(paper.issue) } }
90                      : {}),
91                  },
92                }
93              : {}),
94          },
95        }
96      : {}),
97    ...(paper.firstPage ? { pageStart: paper.firstPage } : {}),
98    ...(paper.lastPage ? { pageEnd: paper.lastPage } : {}),
99    ...(paper.abstract ? { abstract: decodeEntities(paper.abstract) } : {}),
100    // The Unpaywall OA answer, not whether a PDF is hosted here: some hosted copies are not open access.
101    isAccessibleForFree: Boolean(paper.isOpenAccess),
102    ...(paper.license ? { license: paper.license } : {}),
103    ...(context.pdfUrl
104      ? {
105          encoding: {
106            "@type": "MediaObject",
107            encodingFormat: "application/pdf",
108            contentUrl: context.pdfUrl,
109          },
110        }
111      : {}),
112    ...(context.topics && context.topics.length > 0
113      ? { about: context.topics.map((t) => ({ "@type": "Thing", name: t.label })) }
114      : {}),
115  };
116
117  // The Person node first, so the @id the authors reference is defined in the same graph.
118  return [context.personNode, article];
119}