app/lib/identity.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/cv/compile.mjs, app/lib/cv/entries.mjs.

Source

1// The owner's identity, derived from the CV (docs/CV.md): the one-line role, the Person record's job title, the
2// headship, the department and the university. content/cv/profile.md holds the person (name, degree, discipline,
3// department, organization) and content/cv/appointments.md holds what he is appointed to, so a change to either
4// changes every place the site states them: the site settings (app/lib/seo.ts), page titles, the About text, the
5// CV's own header and the structured data. scripts/build-identity.mjs runs this over the files at build and
6// writes app/lib/identity.generated.mjs, which those places import.
7//
8// Pure and dependency-free, so the build, the CV compile and the tests share one definition.
9
10/** The CV's section of ranks and positions, and its section of headships and other leadership. */
11const POSITIONS_SECTION = "Positions";
12const ADMIN_SECTION = "Administrative and leadership";
13
14/**
15 * "a", "a and b", "a, b, and c".
16 *
17 * @param {string[]} items
18 */
19export function joinList(items) {
20  if (items.length <= 1) return items.join("");
21  if (items.length === 2) return `${items[0]} and ${items[1]}`;
22  return `${items.slice(0, -1).join(", ")}, and ${items[items.length - 1]}`;
23}
24
25/**
26 * @typedef {{ name: string, degree: string, discipline: string, department: string, org: string }} IdentityPerson
27 * @typedef {{ type?: string, section?: string, title?: string, endYear?: number | "present" | null, headline?: boolean }} IdentityEntry
28 *
29 * @typedef {{
30 *   name: string,
31 *   degree: string,
32 *   discipline: string,
33 *   disciplineLower: string,
34 *   rank: string,
35 *   role: string,
36 *   adminTitles: string[],
37 *   adminTitle: string,
38 *   jobTitle: string,
39 *   cvTitle: string,
40 *   department: string,
41 *   departmentSubject: string,
42 *   org: string,
43 *   affiliation: string,
44 * }} Identity
45 */
46
47/**
48 * What the CV states he is now: the one current position (its rank is the first half of the role), every current
49 * administrative title (the headship), and the person's discipline (the second half). Returns every problem, so
50 * a CV edit that would leave the site with no role is refused where it is made.
51 *
52 * `role` is "<rank> and <discipline>" ("Professor and Virologist"). `jobTitle` is the Person record's, which also
53 * carries the headship ("Virologist, Professor, and Department Head"). `cvTitle` is the CV header's line.
54 *
55 * @param {IdentityPerson} person
56 * @param {IdentityEntry[]} entries every CV entry; only the appointments are read
57 * @returns {{ ok: false, errors: string[] } | { ok: true, identity: Identity }}
58 */
59export function deriveIdentity(person, entries) {
60  /** @type {string[]} */
61  const errors = [];
62  const current = (/** @type {string} */ section, /** @type {boolean} */ headlineOnly) =>
63    entries
64      .filter(
65        (e) =>
66          e.type === "appointment" &&
67          e.section === section &&
68          e.endYear === "present" &&
69          typeof e.title === "string" &&
70          (!headlineOnly || e.headline === true),
71      )
72      .map((e) => /** @type {string} */ (e.title));
73  const positions = current(POSITIONS_SECTION, false);
74  // Only the leadership entries marked `headline: true` are stated beside the role; the rest stay on the CV alone.
75  const adminTitles = current(ADMIN_SECTION, true);
76  if (positions.length !== 1) {
77    errors.push(
78      `the CV states ${positions.length} current positions (section "${POSITIONS_SECTION}", endYear present); the site's one-line role is built from exactly one`,
79    );
80  }
81  for (const key of /** @type {const} */ (["name", "degree", "discipline", "department", "org"])) {
82    if (typeof person?.[key] !== "string" || person[key].trim() === "") errors.push(`the profile's person.${key} is missing`);
83  }
84  if (errors.length > 0) return { ok: false, errors };
85
86  const rank = /** @type {string} */ (positions[0]);
87  const role = `${rank} and ${person.discipline}`;
88  return {
89    ok: true,
90    identity: {
91      name: person.name,
92      degree: person.degree,
93      discipline: person.discipline,
94      disciplineLower: person.discipline.toLowerCase(),
95      rank,
96      role,
97      adminTitles,
98      adminTitle: joinList(adminTitles),
99      jobTitle: joinList([person.discipline, rank, ...adminTitles]),
100      cvTitle: [role, ...adminTitles].join(", "),
101      department: person.department,
102      departmentSubject: person.department.replace(/^Department of /, ""),
103      org: person.org,
104      // The university alone: the profile's organization carries its system after a comma.
105      affiliation: (person.org.split(",")[0] ?? person.org).trim(),
106    },
107  };
108}