app/kb/registry/equipment.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/kb/registry/host.server.ts, app/kb/registry/kinds.mjs.

Source

1// The equipment kind of the lab registry (docs/REGISTRY.md): the instruments and labware the lab's protocols list under
2// Equipment. Like the reagents, the equipment is one table (the library's Equipment tab) with a page for each item that lists the
3// protocols using it (docs/KNOWLEDGE-BASE.md, A1), and each protocol's own Equipment table is drawn from these records beside the
4// protocol's own words for the item.
5//
6// A record states what the lab's own pages state about one item: its name and who makes it, which is `MISSING: <why>` where no
7// record in the repository says and is listed for Dustin. A centrifuge also carries the rotor its speeds are read for, which is
8// Dustin's to name (core.md: the ZnCl2 rotor), so it is recorded as a gap and the protocols' rpm cannot yet be given as x g.
9//
10// What the protocols do with an item is the PROTOCOLS' and is never stored here: a protocol lists it under its own words (55 °C
11// water bath for molten top agar, plate incubator at 29 °C for M. foliorum) and names the record with `equipment: <id>`, so the
12// setting is the protocol's own and the table lists the protocols that name it.
13
14const LINE = /^[^\r\n]+$/;
15
16/** @param {unknown} value @param {number} max */
17const oneLine = (value, max) =>
18  typeof value === "string" && LINE.test(value) && value === value.trim() && value.length <= max ? null : `is one line of at most ${max} characters`;
19
20/** @type {import("./kinds.mjs").KindSpec} */
21export const EQUIPMENT = {
22  singular: "equipment",
23  plural: "equipment",
24  fields: {
25    manufacturer: { required: true, check: (value) => oneLine(value, 80) },
26    // The rotor a centrifuge's speeds are read for: a protocol gives rpm, and x g needs the rotor (core.md: waiting on Dustin).
27    rotor: { check: (value) => oneLine(value, 120) },
28  },
29};
30
31/**
32 * An equipment item as a protocol carries it (`StoredEquipment` in app/kb/procedures/render.mjs): the registry's stated facts, none
33 * computed, so the protocol's Equipment table, twin and frozen versions say who makes each as it was when the protocol was published.
34 * `rotorGap` is whether a rotor is recorded as missing, so a centrifuge's table says so rather than leaving it blank.
35 *
36 * @param {import("./kinds.mjs").RegistryItem} item
37 * @returns {import("../procedures/render.mjs").StoredEquipment}
38 */
39export function storedEquipment(item) {
40  const f = /** @type {Record<string, unknown>} */ (item.fields);
41  const text = (/** @type {unknown} */ value) => (typeof value === "string" && value !== "" && !value.startsWith("MISSING") ? value : null);
42  return {
43    id: item.id,
44    name: item.name,
45    status: item.status,
46    manufacturer: text(f.manufacturer),
47    rotor: text(f.rotor),
48    rotorGap: typeof f.rotor === "string" && f.rotor.startsWith("MISSING"),
49  };
50}