app/kb/registry/kinds.mjs

Functions

Imports

It imports app/kb/registry/equipment.mjs, app/kb/registry/primer.mjs, app/kb/registry/reagent.mjs, app/kb/registry/strain.mjs. Imported by app/components/lab.tsx, app/kb/admin.mjs, app/kb/editor.server.ts, app/kb/form.server.ts, app/kb/registry/catalog.mjs, app/kb/registry/compile.mjs, app/kb/registry/host.server.ts, app/kb/registry/save.server.ts, app/lib/carrel/registry-handler.server.ts, app/lib/health/checks.server.ts, app/lib/operator/api.server.ts, app/lib/site-urls.server.ts, app/routes/lab.kind.tsx.

Source

1// The kinds the lab registry holds (docs/REGISTRY.md). A kind is data here, not a branch in the compile: its label,
2// its address and the fields it knows beyond the ones every item has (name and status). The compile
3// (compile.mjs), the save, the sync, the drift check and Carrel's handlers all read this one object, so a kind
4// added here is a kind every one of them serves.
5//
6// The registry shipped as a framework with no kind (job_915d43f44cee), and each kind arrives with its own records and
7// pages in its own change: primer, then strain, then reagent and equipment.
8
9import { EQUIPMENT } from "./equipment.mjs";
10import { PRIMER } from "./primer.mjs";
11import { REAGENT } from "./reagent.mjs";
12import { STRAIN } from "./strain.mjs";
13
14/**
15 * What a kind says about one field. `check` returns a message when the value is wrong and null when it is right; it
16 * may be async (a field that names a publication asks the host). A value written "MISSING: <why>" is a recorded gap
17 * and skips `check`, as in a procedure.
18 *
19 * @typedef {{
20 *   required?: boolean,
21 *   check: (value: unknown, context: RegistryContext) => string | null | Promise<string | null>,
22 * }} FieldSpec
23 *
24 * @typedef {{
25 *   singular: string,
26 *   plural: string,
27 *   itemPages?: boolean,
28 *   fields: Record<string, FieldSpec>,
29 *   setErrors?: (items: RegistryItem[]) => string[],
30 * }} KindSpec
31 *
32 * What the host can answer for a file the repository holds, so the Worker (reading GitHub) and Node (reading the
33 * clone) judge a file the same way. `paper` is whether the site holds a publication with that file key, and `recipe` whether the site holds a procedure with the
34 * recipe profile under that file key.
35 *
36 * @typedef {{ paper: (slug: string) => Promise<boolean>, recipe: (slug: string) => Promise<boolean> }} RegistryHost
37 * @typedef {{ host: RegistryHost, data: Record<string, unknown> }} RegistryContext
38 *
39 * One item as the table holds it: the shared columns and the kind's own fields, `null` where a kind's field is
40 * absent. `fields` never repeats a shared column.
41 *
42 * @typedef {{ kind: string, id: string, name: string, status: "published" | "draft", fields: Record<string, unknown> }} RegistryItem
43 */
44
45/** @type {Readonly<Record<string, KindSpec>>} */
46export const KINDS = Object.freeze({ primer: PRIMER, strain: STRAIN, reagent: REAGENT, equipment: EQUIPMENT });
47
48/** The kinds in the order the site lists them, which is the order they are defined in. @param {Record<string, KindSpec>} [kinds] */
49export function kindKeys(kinds = KINDS) {
50  return Object.keys(kinds);
51}