app/lib/publications/types.ts

Functions

None: it only declares types or values.

Imports

It imports no other module of this repo. Imported by app/db/publications.ts, app/lib/carrel/publication-handler.server.ts, app/lib/publications/by-slug.ts, app/routes/home.tsx, app/routes/publications.tsx.

Source

1// The shapes a publication takes once its file is compiled. Types only: the vocabulary lives in
2// topics.mjs and validate.mjs, and the file format is docs/PUBLICATIONS.md.
3
4export type TopicId =
5  | "human-simian-retroviruses"
6  | "avian-retroviruses"
7  | "bacteriophages"
8  | "science-education";
9
10export type PublicationType = "article" | "review" | "chapter" | "abstract" | "teaching-resource";
11
12type Access = "self-hosted" | "external";
13
14/** `published` has a DOI and a registry record; `submitted` is a manuscript under review, with neither. */
15type PublicationStage = "published" | "submitted";
16
17export type Publication = {
18  /** The file's name and the page's address. From the DOI, or written in the file when there is none. */
19  slug: string;
20  /** The curated id, which is also the BibTeX key. */
21  id: string;
22  stage: PublicationStage;
23  title: string;
24  authors: string[];
25  journal: string | null;
26  year: number;
27  /** The deposited date at its own precision: YYYY-MM-DD, YYYY-MM or YYYY. */
28  publishedDate: string | null;
29  volume: string | null;
30  issue: string | null;
31  pages: string | null;
32  /** Set only where `pages` is genuinely a range or a first page. */
33  firstPage: string | null;
34  lastPage: string | null;
35  /** Null only for a submitted manuscript. */
36  doi: string | null;
37  pmid: string | null;
38  pmcid: string | null;
39  pmcUrl: string | null;
40  type: PublicationType;
41  topics: TopicId[];
42  access: Access;
43  /** Set when access is "self-hosted". */
44  pdfPath: string | null;
45  /** Set when access is "external". */
46  externalUrl: string | null;
47  /** Preprint of this record, where one exists. */
48  preprintDoi: string | null;
49  isOpenAccess: boolean;
50  license: string | null;
51  /** Which registry said so, and at what content version. Null means no terms were found at either. */
52  licenseSource: string | null;
53  /** One plain-language sentence under 200 characters, or null. */
54  summary: string | null;
55  /** A retraction, correction or expression of concern, or null. */
56  updateNotice: {
57    type: "retraction" | "correction" | "expression-of-concern";
58    doi: string;
59    date: string | null;
60  } | null;
61  /** Sequence accessions the paper's own data-availability statement names. */
62  accessions: { kind: string; id: string }[];
63  selected: boolean;
64  abstract: string | null;
65};