app/lib/cv/types.ts

Functions

None: it only declares types or values.

Imports

It imports no other module of this repo. Imported by app/db/cv.ts.

Source

1/**
2 * The shapes of the CV's source entries: what a file in content/cv/ states (docs/CV.md), before
3 * app/lib/cv/entries.mjs resolves it into the entries every surface renders. Types only. The checks that hold
4 * a file to them are in app/lib/cv/validate.mjs.
5 *
6 * PRIVACY (Capsid dustinedwards/decisions.md, PROTECTED): no student is named anywhere in the CV files. Mentoring is a count by
7 * cohort, year, level and program; students appear only inside the published author lists of papers. No phone,
8 * room, email or home location, and no private community groups.
9 *
10 * AREAS are the site's four research areas, and each tag must be defensible from the entry itself.
11 * Where it is not, the list is empty rather than guessed.
12 */
13
14export type CvArea = "retroviruses" | "bacteriophages" | "science-education" | "ai";
15
16export type CvType =
17  | "appointment"
18  | "education"
19  | "publication"
20  | "grant"
21  | "award"
22  | "talk"
23  | "course"
24  | "mentoring"
25  | "service"
26  | "development";
27
28export type CvRole =
29  | "first-author"
30  | "senior-author"
31  | "co-author"
32  | "recipient"
33  | "speaker"
34  | "instructor"
35  | "mentor"
36  | "chair"
37  | "organizer"
38  | "member"
39  | "editor"
40  | "reviewer"
41  | "judge"
42  | "advisor"
43  | "volunteer"
44  | "consultant"
45  | "participant";
46
47export type CvLink = { label: string; href: string };
48
49/**
50 * `year` is when it started; `endYear` is when it ended, "present" while it continues, or absent for
51 * a single year. A null year is an undated line (a membership, a canceled meeting): it matches no year
52 * range and sorts last.
53 */
54type Dated = { year: number | null; endYear?: number | "present" };
55
56type Tagged = { areas: CvArea[]; role: CvRole | null; links?: CvLink[] };
57
58/** A paper the site has a record for: everything but the DOI comes from its file in content/publications/. */
59type CvPaperRef = { type: "publication"; doi: string };
60
61/** A paper with no site record, cited as the CV cites it. */
62type CvPaperInline = Dated &
63  Tagged & {
64    type: "publication";
65    title: string;
66    authors: string[];
67    journal: string;
68    volume?: string;
69    issue?: string;
70    pages?: string;
71  };
72
73type CvAppointment = Dated &
74  Tagged & {
75    type: "appointment";
76    section: "Positions" | "Administrative and leadership";
77    title: string;
78    org: string;
79    detail?: string;
80    /** Duties, grouped as the CV groups them. */
81    duties?: { heading: string; items: string[] }[];
82    /**
83     * A current leadership title the site states beside the role (the headship): in the Person record's job
84     * title, on the About page and on the CV's header. Other leadership entries stay on the CV alone.
85     */
86    headline?: boolean;
87  };
88
89type CvEducation = Dated &
90  Tagged & { type: "education"; title: string; org: string; detail?: string };
91
92type CvGrant = Dated &
93  Tagged & {
94    type: "grant";
95    /** US dollars, as the CV states them. */
96    amount: number;
97    title: string;
98    funder?: string;
99    /** "with a student researcher" and the like; never a name. */
100    note?: string;
101  };
102
103type CvAward = Dated & Tagged & { type: "award"; title: string; org?: string; place?: string };
104
105type CvTalk = Dated &
106  Tagged & {
107    type: "talk";
108    title: string;
109    /** As the CV lists them; the co-presenters are faculty colleagues. */
110    presenters: string[];
111    venue: string;
112  };
113
114type CvCourse = Dated &
115  Tagged & { type: "course"; code: string; title: string; org: string; term: string };
116
117type CvMentoring = Dated &
118  Tagged & {
119    type: "mentoring";
120    section: string;
121    count: number;
122    /** Students, or awards the mentored students won. Only students add to the students total. */
123    unit: "students" | "awards";
124    level: string;
125    program: string;
126    org: string;
127    detail?: string;
128    /** One cohort or academic year, so the count belongs to `year` alone and can be charted by year. */
129    cohort: boolean;
130  };
131
132type CvService = Dated &
133  Tagged & {
134    type: "service";
135    section:
136      | "Department"
137      | "College"
138      | "University"
139      | "Professional"
140      | "Community"
141      | "Compensated professional consulting"
142      | "Professional memberships";
143    title: string;
144    org?: string;
145    place?: string;
146  };
147
148type CvDevelopment = Dated & Tagged & { type: "development"; title: string; org?: string; place?: string };
149
150export type CvSourceEntry =
151  | CvPaperRef
152  | CvPaperInline
153  | CvAppointment
154  | CvEducation
155  | CvGrant
156  | CvAward
157  | CvTalk
158  | CvCourse
159  | CvMentoring
160  | CvService
161  | CvDevelopment;
162
163/** The people the CV is about, as content/cv/profile.md states them. */
164/** What the profile states. The person's title is not stated: it is derived (CvPersonView). */
165export type CvPerson = {
166  name: string;
167  degree: string;
168  /** The field he works in, "Virologist": the second half of the one-line role. */
169  discipline: string;
170  department: string;
171  org: string;
172};
173
174/** The CV's own totals for presentations; only invited talks where Dustin leads are entries. */
175export type CvPresentations = { international: number; national: number; from: number; to: number };
176
177/** What the files hold, assembled in the order of CV_FILES (app/lib/cv/parse.mjs): one flat entry list. */
178export type CvSource = {
179  edition: string;
180  person: CvPerson;
181  presentations: CvPresentations;
182  entries: CvSourceEntry[];
183};
184
185/**
186 * What one file becomes, as D1's `cv.record` holds it and as the save, the sync and the build write it:
187 * the profile's facts, or a section's entries with their type stated.
188 */
189export type CvFileRecord =
190  | { slug: "profile"; type: "profile"; edition: string; person: CvPerson; presentations: CvPresentations }
191  | { slug: string; type: CvType; entries: CvSourceEntry[] };