app/lib/cv/entries.mjs

Functions

Imports

It imports app/lib/cv/view.mjs, app/lib/identity.generated.mjs, app/lib/identity.mjs, app/lib/publications/authors.mjs, app/lib/publications/entities.mjs, app/lib/publications/paths.mjs. Imported by app/lib/carrel/cv-handler.server.ts, app/lib/cv/compile.mjs, app/lib/cv/markdown.mjs, app/lib/nav.ts, app/routes/cv.charts[.json].ts, app/routes/cv.tsx, app/routes/cv[.md].ts.

Source

1/**
2 * The CV resolved: the files in content/cv/ (assembled by app/lib/cv/compile.mjs) joined to the publication
3 * records, one flat list every surface renders. The page (app/routes/cv.tsx), the markdown twin
4 * (app/lib/cv/markdown.mjs, served by app/routes/cv[.md].ts) and the PDF (rendered from the twin by
5 * app/lib/cv/pdf.server.ts, and offline by scripts/build-cv-pdf.mjs) all resolve it with `buildCv`, so they cannot say different things. Pure and clock-free, so the twin and
6 * the PDF fingerprint are reproducible.
7 */
8
9import { deriveIdentity } from "../identity.mjs";
10import { IDENTITY } from "../identity.generated.mjs";
11import { canonicalAuthor } from "../publications/authors.mjs";
12import { decodeEntities } from "../publications/entities.mjs";
13import { paperPath, paperPdfPath } from "../publications/paths.mjs";
14import { areaLabel, foldText, formatDollars, roleLabel, typeLabel } from "./view.mjs";
15
16export { formatDollars };
17
18/** @typedef {import("./types.ts").CvType} CvType */
19/** @typedef {import("./types.ts").CvArea} CvArea */
20/** @typedef {import("./types.ts").CvRole} CvRole */
21/** @typedef {import("./types.ts").CvLink} CvLink */
22/** @typedef {import("./types.ts").CvSourceEntry} CvSourceEntry */
23/** @typedef {import("./types.ts").CvSource} CvSource */
24/** @typedef {import("../publications/types.ts").Publication} Publication */
25/** @typedef {import("../publications/types.ts").TopicId} TopicId */
26
27/**
28 * @typedef {object} CvPaper
29 * @property {string[]} authors as the record lists them, the owner included
30 * @property {string} venue journal, volume(issue):pages
31 * @property {string | null} doi
32 * @property {string | null} pagePath the site's page for the paper, which carries the abstract
33 * @property {string | null} pdfPath
34 * @property {string | null} pmid
35 * @property {string | null} pmcUrl
36 * @property {boolean} hasAbstract
37 * @property {string} citation the plain citation a reader copies
38 * @property {string | null} bibtexPath the site's .bib export, or null when the text is inline
39 * @property {string | null} risPath
40 * @property {string | null} bibtex inline BibTeX, for a paper the site has no record for
41 * @property {string | null} ris
42 * @property {Publication | null} record the site record, for JSON-LD
43 */
44
45/**
46 * @typedef {object} CvEntry
47 * @property {string} id a stable anchor, unique across the CV
48 * @property {CvType} type
49 * @property {string | null} section the subsection it sits under when grouped by type
50 * @property {number | null} year when it started
51 * @property {number | "present" | null} endYear null for a single year
52 * @property {string} when the dates as printed: "2019", "2014-2020", "2015-present", or ""
53 * @property {CvArea[]} areas
54 * @property {CvRole | null} role
55 * @property {string} title the entry's first line
56 * @property {string[]} meta the lines after it
57 * @property {string | null} note
58 * @property {CvLink[]} links
59 * @property {CvPaper | null} paper
60 * @property {number | null} amount a grant's US dollars
61 * @property {number | null} students how many students a mentoring line counts
62 * @property {boolean} cohort a mentoring count that belongs to its start year alone
63 * @property {{ heading: string, items: string[] }[]} duties
64 * @property {string} search folded text the search box matches
65 */
66
67/** The PDF's public path: a Worker route over one R2 object the Worker renders after each CV save (app/routes/cv-pdf.ts). */
68export const CV_PDF_PATH = "/dustin-edwards-cv.pdf";
69
70export const CV_PAGE = {
71  path: "/cv",
72  title: "Curriculum Vitae",
73  seoTitle: `${IDENTITY.name} CV: ${IDENTITY.role}, Tarleton`,
74  description: `${IDENTITY.name}'s CV: ${IDENTITY.role} at ${IDENTITY.affiliation}. Appointments, education, publications, grants, teaching and service.`,
75};
76
77/** @type {Record<TopicId, CvArea>} */
78const TOPIC_AREA = {
79  "human-simian-retroviruses": "retroviruses",
80  "avian-retroviruses": "retroviruses",
81  bacteriophages: "bacteriophages",
82  "science-education": "science-education",
83};
84
85const OWNER = "Dustin Edwards";
86
87/** @param {string} value */
88function slugify(value) {
89  return value
90    .normalize("NFKD")
91    .replace(/[̀-ͯ]/g, "")
92    .toLowerCase()
93    .replace(/[^a-z0-9]+/g, "-")
94    .replace(/^-+|-+$/g, "")
95    .slice(0, 48)
96    .replace(/-+$/g, "");
97}
98
99/**
100 * @param {number | null} year
101 * @param {number | "present" | undefined} endYear
102 */
103function formatWhen(year, endYear) {
104  if (year === null) return "";
105  if (endYear === undefined || endYear === year) return String(year);
106  return `${year}-${endYear}`;
107}
108
109/**
110 * @param {string | null} journal
111 * @param {string | null | undefined} volume
112 * @param {string | null | undefined} issue
113 * @param {string | null | undefined} pages
114 */
115function venueOf(journal, volume, issue, pages) {
116  let out = decodeEntities(journal ?? "");
117  if (volume) out += ` ${volume}${issue ? `(${issue})` : ""}`;
118  if (pages) out += `${volume ? ":" : ", "}${pages}`;
119  return out.trim();
120}
121
122/** @param {Publication} p @returns {CvRole} */
123function authorRole(p) {
124  const at = p.authors.findIndex((name) => canonicalAuthor(name) === OWNER);
125  if (at < 0) {
126    throw new Error(`cv: ${p.doi} does not list ${OWNER} among its authors, so the CV cannot claim it.`);
127  }
128  if (at === 0) return "first-author";
129  if (at === p.authors.length - 1) return "senior-author";
130  return "co-author";
131}
132
133/**
134 * @param {string[]} authors
135 * @param {number | null} year
136 * @param {string} title
137 * @param {string} venue
138 * @param {string | null} doi
139 */
140function plainCitation(authors, year, title, venue, doi) {
141  const names = authors.map((name) => canonicalAuthor(name)).join(", ");
142  const end = /[.?!]$/.test(title) ? "" : ".";
143  return `${names}. ${year ?? "n.d."}. ${title}${end} ${venue}.${doi ? ` https://doi.org/${doi}` : ""}`;
144}
145
146/**
147 * @param {CvSourceEntry} source
148 * @param {Map<string, Publication>} byDoi the publication records by lower-cased DOI
149 * @returns {Omit<CvEntry, "id" | "search">}
150 */
151function resolveOne(source, byDoi) {
152  const base = {
153    section: null,
154    note: null,
155    links: /** @type {CvLink[]} */ ([]),
156    paper: null,
157    amount: null,
158    students: null,
159    cohort: false,
160    duties: /** @type {{ heading: string, items: string[] }[]} */ ([]),
161  };
162
163  if (source.type === "publication" && "doi" in source) {
164    const p = byDoi.get(source.doi.toLowerCase());
165    if (!p) {
166      throw new Error(`cv: no publication record for DOI ${source.doi}; add its file to content/publications/ first.`);
167    }
168    const title = decodeEntities(p.title);
169    const venue = venueOf(p.journal, p.volume, p.issue, p.pages);
170    const { slug } = p;
171    const areas = [...new Set(p.topics.map((t) => TOPIC_AREA[t]))];
172    /** @type {CvLink[]} */
173    const links = [{ label: "DOI", href: `https://doi.org/${p.doi}` }];
174    if (p.pmid) links.push({ label: "PubMed", href: `https://pubmed.ncbi.nlm.nih.gov/${p.pmid}/` });
175    if (p.pmcUrl) links.push({ label: "PMC", href: p.pmcUrl });
176    return {
177      ...base,
178      type: "publication",
179      year: p.year,
180      endYear: null,
181      when: String(p.year),
182      areas,
183      role: authorRole(p),
184      title,
185      meta: [venue],
186      links,
187      paper: {
188        authors: p.authors.map((name) => decodeEntities(name)),
189        venue,
190        doi: p.doi,
191        pagePath: paperPath(slug),
192        pdfPath: p.access === "self-hosted" && p.pdfPath ? paperPdfPath(slug) : null,
193        pmid: p.pmid,
194        pmcUrl: p.pmcUrl,
195        hasAbstract: Boolean(p.abstract),
196        citation: plainCitation(p.authors, p.year, title, venue, p.doi),
197        bibtexPath: `/research/publications/${slug}.bib`,
198        risPath: `/research/publications/${slug}.ris`,
199        bibtex: null,
200        ris: null,
201        record: p,
202      },
203    };
204  }
205
206  const when = formatWhen(source.year, source.endYear);
207  const common = {
208    ...base,
209    year: source.year,
210    endYear: source.endYear ?? null,
211    when,
212    areas: source.areas,
213    role: source.role,
214    links: source.links ?? [],
215  };
216
217  switch (source.type) {
218    case "publication": {
219      const venue = venueOf(source.journal, source.volume, source.issue, source.pages);
220      const key = `${slugify(source.authors[0]?.split(" ").pop() ?? "cv")}-${source.year}-${slugify(source.title).split("-").slice(0, 3).join("-")}`;
221      const bibtex = [
222        `@article{${key},`,
223        `  title = {${source.title}},`,
224        `  author = {${source.authors.join(" and ")}},`,
225        `  journal = {${source.journal}},`,
226        `  year = {${source.year}},`,
227        ...(source.volume ? [`  volume = {${source.volume}},`] : []),
228        ...(source.issue ? [`  number = {${source.issue}},`] : []),
229        ...(source.pages ? [`  pages = {${source.pages.replace("-", "--")}},`] : []),
230        "}",
231      ].join("\n");
232      const pages = source.pages?.split("-") ?? [];
233      const ris = [
234        "TY  - JOUR",
235        `TI  - ${source.title}`,
236        ...source.authors.map((name) => `AU  - ${name}`),
237        `JO  - ${source.journal}`,
238        `PY  - ${source.year}`,
239        ...(source.volume ? [`VL  - ${source.volume}`] : []),
240        ...(source.issue ? [`IS  - ${source.issue}`] : []),
241        ...(pages[0] ? [`SP  - ${pages[0]}`] : []),
242        ...(pages[1] ? [`EP  - ${pages[1]}`] : []),
243        "ER  - ",
244      ].join("\n");
245      return {
246        ...common,
247        type: "publication",
248        title: source.title,
249        meta: [venue],
250        paper: {
251          authors: source.authors,
252          venue,
253          doi: null,
254          pagePath: null,
255          pdfPath: null,
256          pmid: null,
257          pmcUrl: null,
258          hasAbstract: false,
259          citation: plainCitation(source.authors, source.year, source.title, venue, null),
260          bibtexPath: null,
261          risPath: null,
262          bibtex,
263          ris,
264          record: null,
265        },
266      };
267    }
268    case "appointment":
269      return {
270        ...common,
271        type: "appointment",
272        section: source.section,
273        title: source.title,
274        meta: [source.org, ...(source.detail ? [source.detail] : [])],
275        duties: source.duties ?? [],
276      };
277    case "education":
278      return {
279        ...common,
280        type: "education",
281        title: source.title,
282        meta: [source.org, ...(source.detail ? [source.detail] : [])],
283      };
284    case "grant":
285      return {
286        ...common,
287        type: "grant",
288        title: source.title,
289        meta: [source.funder ?? ""].filter(Boolean),
290        note: source.note ?? null,
291        amount: source.amount,
292      };
293    case "award":
294      return {
295        ...common,
296        type: "award",
297        title: source.title,
298        meta: [[source.org, source.place].filter(Boolean).join(", ")].filter(Boolean),
299      };
300    case "talk":
301      return {
302        ...common,
303        type: "talk",
304        title: source.title,
305        meta: [source.venue, ...(source.presenters.length > 1 ? [`With ${source.presenters.slice(1).join(", ")}`] : [])],
306      };
307    case "course":
308      return {
309        ...common,
310        type: "course",
311        title: `${source.code}: ${source.title}`,
312        meta: [`${source.org}, ${source.term}`],
313      };
314    case "mentoring": {
315      const counted = `${source.count} ${source.unit === "awards" ? (source.count === 1 ? "award" : "awards") : source.count === 1 ? "student" : "students"}`;
316      return {
317        ...common,
318        type: "mentoring",
319        section: source.section,
320        title: `${counted}: ${source.level}`,
321        meta: [source.program, source.org, ...(source.detail ? [source.detail] : [])],
322        students: source.unit === "students" ? source.count : null,
323        cohort: source.cohort,
324      };
325    }
326    case "service":
327      return {
328        ...common,
329        type: "service",
330        section: source.section,
331        title: source.title,
332        meta: [[source.org, source.place].filter(Boolean).join(", ")].filter(Boolean),
333      };
334    case "development":
335      return {
336        ...common,
337        type: "development",
338        title: source.title,
339        meta: [[source.org, source.place].filter(Boolean).join(", ")].filter(Boolean),
340      };
341    default:
342      throw new Error(`cv: an entry has no known type: ${JSON.stringify(source)}`);
343  }
344}
345
346/**
347 * @param {CvSourceEntry[]} sources
348 * @param {Publication[]} publications
349 * @returns {CvEntry[]}
350 */
351function resolveAll(sources, publications) {
352  /** @type {Map<string, Publication>} */
353  const byDoi = new Map(publications.flatMap((p) => (p.doi ? [[p.doi.toLowerCase(), p]] : [])));
354  const seen = new Map();
355  return sources.map((source) => {
356    const entry = resolveOne(source, byDoi);
357    const stem = `${entry.type}-${entry.year ?? "undated"}-${slugify(entry.title)}`;
358    const n = (seen.get(stem) ?? 0) + 1;
359    seen.set(stem, n);
360    const id = n === 1 ? stem : `${stem}-${n}`;
361    const search = foldText(
362      [
363        entry.title,
364        ...entry.meta,
365        entry.note ?? "",
366        entry.when,
367        ...(entry.paper ? entry.paper.authors : []),
368        ...entry.duties.flatMap((d) => [d.heading, ...d.items]),
369      ].join(" "),
370    );
371    return { ...entry, id, search };
372  });
373}
374
375/**
376 * @param {CvSource} source what the files state (assembleCvSource)
377 * @param {Publication[]} publications the published records: D1's (app/db/cv.ts) or the build's
378 *   (scripts/lib/publications.mjs)
379 */
380export function buildCv(source, publications) {
381  // The header's title is derived from the current appointments and the discipline, never stated in the profile.
382  const derived = deriveIdentity(source.person, source.entries);
383  if (!derived.ok) throw new Error(`the CV cannot give a title: ${derived.errors.join("; ")}`);
384  return {
385    edition: source.edition,
386    person: { ...source.person, title: derived.identity.cvTitle },
387    presentations: source.presentations,
388    entries: resolveAll(source.entries, publications),
389  };
390}
391
392/** @typedef {ReturnType<typeof buildCv>} Cv */
393
394/**
395 * What filtering reads from each entry (app/lib/cv/view.mjs). The search text also carries the type,
396 * role and area labels the page prints beside the entry, so a word a reader can see is a word the
397 * search finds, on the server and in the browser alike.
398 *
399 * @param {CvEntry[]} entries
400 * @returns {import("./view.mjs").Facts[]}
401 */
402export function cvFacts(entries) {
403  return entries.map((e, order) => ({
404    id: e.id,
405    type: e.type,
406    section: e.section,
407    areas: e.areas,
408    role: e.role,
409    year: e.year,
410    endYear: e.endYear,
411    students: e.students,
412    cohort: e.cohort,
413    amount: e.amount,
414    order,
415    search: foldText(
416      [e.search, typeLabel(e.type), e.role ? roleLabel(e.role) : "", ...e.areas.map(areaLabel)].join(" "),
417    ),
418  }));
419}