app/lib/publications/update-notice.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/publications/validate.mjs, app/routes/publications.$slug.tsx.

Source

1// No record carries a notice today; the path is built cold so a correction needs only a data change,
2// and a test drives it with a real retracted DOI. The paper carries updated-by (the notice carries
3// update-to), so the DOI here is the notice's.
4
5export const UPDATE_TYPES = /** @type {const} */ ([
6  "retraction",
7  "correction",
8  "expression-of-concern",
9]);
10
11const LABEL = {
12  retraction: "Retracted",
13  correction: "Corrected",
14  "expression-of-concern": "Expression of concern",
15};
16
17/**
18 * @typedef {object} UpdateNotice
19 * @property {string} type one of UPDATE_TYPES
20 * @property {string} doi the NOTICE's DOI, not the paper's
21 * @property {string | null} [date] YYYY-MM-DD, as deposited
22 */
23
24/**
25 * A reason, not a boolean, so the gate can say which part of a notice is malformed.
26 *
27 * @param {unknown} value
28 * @returns {string | null} null when the notice is usable
29 */
30export function updateNoticeProblem(value) {
31  if (value === null || value === undefined) return null;
32  if (typeof value !== "object") return "not an object";
33  const notice = /** @type {Record<string, unknown>} */ (value);
34  if (!UPDATE_TYPES.includes(/** @type {any} */ (notice.type))) {
35    return `type ${JSON.stringify(notice.type)} is not one of ${UPDATE_TYPES.join(", ")}`;
36  }
37  // Shape only: checking existence would put a network call in a gate.
38  if (typeof notice.doi !== "string" || !/^10\.\d{4,9}\/\S+$/.test(notice.doi)) {
39    return `doi ${JSON.stringify(notice.doi)} is not a DOI name`;
40  }
41  if (
42    notice.date !== null &&
43    notice.date !== undefined &&
44    !(typeof notice.date === "string" && /^\d{4}-\d{2}-\d{2}$/.test(notice.date))
45  ) {
46    return `date ${JSON.stringify(notice.date)} is not YYYY-MM-DD`;
47  }
48  return null;
49}
50
51/**
52 * Links to the notice's own DOI, the only honest citation for it. The deposited date is in the sentence
53 * so an undated retraction is not read as recent.
54 *
55 * @param {UpdateNotice} notice
56 * @returns {{ label: string, sentence: string, url: string }}
57 */
58export function updateNoticeText(notice) {
59  const problem = updateNoticeProblem(notice);
60  if (problem) {
61    // Every caller passed the gate, so data changed under a green build; a 500 beats a half-rendered notice.
62    throw new Error(`unusable update notice: ${problem}`);
63  }
64  const label = LABEL[/** @type {keyof typeof LABEL} */ (notice.type)];
65  const when = notice.date ? ` on ${notice.date}` : "";
66  return {
67    label,
68    sentence:
69      notice.type === "expression-of-concern"
70        ? `The publisher has issued an expression of concern about this paper${when}.`
71        : `This paper was ${label.toLowerCase()}${when} by the publisher.`,
72    url: `https://doi.org/${notice.doi}`,
73  };
74}