app/lib/publications/record.mjs

Functions

Imports

It imports app/lib/publications/paths.mjs. Imported by app/db/publications.ts, app/lib/publications/compile.mjs.

Source

1// The compiled record: what a publication file becomes once it is validated, in the shape every surface
2// (the index, the paper page, the exports, search, the CV) reads. Derived values are derived here and
3// nowhere else: the year from the date, the page range from `pages`.
4
5import { paperPdfPath } from "./paths.mjs";
6
7// Written as an escape: the repo's hook refuses the literal wide dash, and an invisible-width
8// character in a class is unreviewable.
9const PAGE_RANGE = new RegExp("^(\\d+)\\s*[-\\u2013]\\s*(\\d+)$");
10
11/**
12 * Some records carry an article number rather than pagination, so this is a positive match on the
13 * range shape, never a split on the separator.
14 *
15 * @param {string | null | undefined} page
16 * @returns {{ first: string | null, last: string | null }}
17 */
18function pageRange(page) {
19  const value = (page ?? "").trim();
20  const range = PAGE_RANGE.exec(value);
21  if (range) return { first: range[1] ?? null, last: range[2] ?? null };
22  if (/^\d+$/.test(value)) return { first: value, last: null };
23  return { first: null, last: null };
24}
25
26/** @param {unknown} value @returns {string | null} */
27const text = (value) => (value === null || value === undefined || value === "" ? null : String(value));
28
29/**
30 * @param {Record<string, any>} data the validated front matter
31 * @param {string} slug the file's name
32 * @returns {import("./types.ts").Publication}
33 */
34export function recordFromData(data, slug) {
35  const stage = data.status === "submitted" ? "submitted" : "published";
36  const publishedDate = text(data.publishedDate);
37  // From the date it was deposited at; a manuscript with no date yet names its year.
38  const year = publishedDate ? Number(publishedDate.slice(0, 4)) : Number(data.year);
39  const { first, last } = pageRange(text(data.pages));
40  const doi = text(data.doi);
41  return {
42    id: data.id,
43    title: data.title,
44    authors: [...data.authors],
45    journal: text(data.journal),
46    year,
47    publishedDate,
48    volume: text(data.volume),
49    issue: text(data.issue),
50    pages: text(data.pages),
51    firstPage: first,
52    lastPage: last,
53    doi,
54    pmid: text(data.pmid),
55    pmcid: text(data.pmcid),
56    pmcUrl: text(data.pmcUrl),
57    type: data.type,
58    topics: [...data.topics],
59    access: data.access,
60    pdfPath: data.access === "self-hosted" ? (text(data.pdfPath) ?? paperPdfPath(slug)) : null,
61    externalUrl: text(data.externalUrl),
62    preprintDoi: text(data.preprintDoi),
63    isOpenAccess: data.isOpenAccess === true,
64    license: text(data.license),
65    licenseSource: text(data.licenseSource),
66    summary: text(data.summary),
67    updateNotice: data.updateNotice ? { type: data.updateNotice.type, doi: data.updateNotice.doi, date: data.updateNotice.date ?? null } : null,
68    accessions: Array.isArray(data.accessions) ? data.accessions.map((/** @type {any} */ a) => ({ kind: a.kind, id: a.id })) : [],
69    selected: data.selected === true,
70    abstract: text(data.abstract),
71    slug,
72    stage,
73  };
74}
75
76/**
77 * Newest first, then by title lowercased: the order the generated module held, which the index, the
78 * exports and the CSL file all follow. Compared with `<`, not localeCompare, as the generator did.
79 *
80 * @template {{ year: number, title: string }} T
81 * @param {T[]} records
82 * @returns {T[]}
83 */
84export function sortPublications(records) {
85  return [...records].sort((a, b) => {
86    if (b.year !== a.year) return b.year - a.year;
87    const x = a.title.toLowerCase();
88    const y = b.title.toLowerCase();
89    return x < y ? -1 : x > y ? 1 : 0;
90  });
91}