app/lib/publications/serialize.mjs

Functions

Imports

It imports app/lib/publications/parse.mjs. No module of this repo imports it.

Source

1// Writes a publication file: the front matter in one fixed key order, every string double quoted (YAML's
2// double-quoted style is a superset of JSON strings, so JSON.stringify is the escaper and no value can be
3// read back as a date, a boolean or a number it was not). Used by the one-time migration, by the PDF text
4// extractor, which rewrites a file's Full text section in place, and by the tests.
5
6import { FULL_TEXT_HEADING } from "./parse.mjs";
7
8/** Canonical order. A key not listed here is a key the validator refuses. */
9const FRONT_MATTER_KEYS = [
10  "doi",
11  "slug",
12  "id",
13  "status",
14  "draft",
15  "type",
16  "title",
17  "authors",
18  "journal",
19  "publishedDate",
20  "year",
21  "volume",
22  "issue",
23  "pages",
24  "topics",
25  "access",
26  "pdfPath",
27  "pdfSha256",
28  "externalUrl",
29  "pmid",
30  "pmcid",
31  "pmcUrl",
32  "preprintDoi",
33  "isOpenAccess",
34  "license",
35  "licenseSource",
36  "summary",
37  "selected",
38  "accessions",
39  "updateNotice",
40  "abstract",
41  "csl",
42];
43
44const PLAIN_KEY = /^[A-Za-z0-9_][A-Za-z0-9_-]*$/;
45
46/** @param {unknown} value */
47const isScalar = (value) => value === null || ["string", "number", "boolean"].includes(typeof value);
48
49/** @param {unknown} value */
50function scalar(value) {
51  if (value === null) return "null";
52  return typeof value === "string" ? JSON.stringify(value) : String(value);
53}
54
55/** @param {string} key */
56const keyText = (key) => (PLAIN_KEY.test(key) ? key : JSON.stringify(key));
57
58/**
59 * @param {string} key
60 * @param {unknown} value
61 * @param {number} indent
62 * @returns {string[]}
63 */
64function entry(key, value, indent) {
65  const pad = " ".repeat(indent);
66  const k = keyText(key);
67  if (isScalar(value)) return [`${pad}${k}: ${scalar(value)}`];
68  if (Array.isArray(value)) {
69    if (value.length === 0) return [`${pad}${k}: []`];
70    if (value.every(isScalar)) return [`${pad}${k}:`, ...value.map((v) => `${pad}  - ${scalar(v)}`)];
71    if (value.every((v) => v && typeof v === "object" && !Array.isArray(v))) {
72      return [
73        `${pad}${k}:`,
74        ...value.flatMap((item) => {
75          const lines = block(/** @type {Record<string, unknown>} */ (item), indent + 4);
76          if (lines.length === 0) return [`${pad}  - {}`];
77          // The first line of the mapping rides on the dash: "- " is the two columns the indent gained.
78          return [`${pad}  - ${(lines[0] ?? "").slice(indent + 4)}`, ...lines.slice(1)];
79        }),
80      ];
81    }
82    // Arrays of arrays (a date-parts triple): one line of flow style, which is JSON.
83    return [`${pad}${k}: ${JSON.stringify(value)}`];
84  }
85  const lines = block(/** @type {Record<string, unknown>} */ (value), indent + 2);
86  return lines.length === 0 ? [`${pad}${k}: {}`] : [`${pad}${k}:`, ...lines];
87}
88
89/**
90 * @param {Record<string, unknown>} object
91 * @param {number} indent
92 * @returns {string[]}
93 */
94function block(object, indent) {
95  return Object.entries(object).flatMap(([key, value]) => (value === undefined ? [] : entry(key, value, indent)));
96}
97
98/**
99 * @param {Record<string, unknown>} data front matter fields; null and undefined values are left out
100 * @param {string | null} fullText the extracted text, or null for a file with no Full text section
101 * @returns {string}
102 */
103export function renderPublicationFile(data, fullText) {
104  const known = new Set(FRONT_MATTER_KEYS);
105  const unknown = Object.keys(data).filter((key) => !known.has(key));
106  if (unknown.length > 0) throw new Error(`renderPublicationFile: not front matter fields: ${unknown.join(", ")}`);
107  const lines = FRONT_MATTER_KEYS.flatMap((key) => {
108    const value = data[key];
109    return value === null || value === undefined ? [] : entry(key, value, 0);
110  });
111  const head = ["---", ...lines, "---", ""].join("\n");
112  return fullText === null ? head : `${head}\n${FULL_TEXT_HEADING}\n\n${fullText}\n`;
113}