app/kb/procedures/route.ts

Functions

Imports

It imports app/kb/libraries.mjs, app/kb/procedures/recipe-views.mjs, app/kb/procedures/render.mjs. Imported by app/kb/registry/route.ts, app/routes/kb-library.tsx, app/routes/kb-library[.csv].ts, app/routes/kb-library[.json].ts, app/routes/kb-library[.md].ts, app/routes/procedure.sheet.tsx, app/routes/procedure.tsx, app/routes/procedure.version.sheet.tsx, app/routes/procedure.version.tsx, app/routes/procedure.version[.md].ts, app/routes/procedure[.md].ts, app/routes/protocols.tsx, app/routes/protocols[.csv].ts, app/routes/protocols[.json].ts, app/routes/protocols[.md].ts.

Source

1// What the procedure page, its sheet and its twin share: the cache tag, the trail and the scale a
2// request asks for.
3import { LIBRARY_BASES, libraryTrail } from "../libraries.mjs";
4import type { ProcedureRecord } from "./render.mjs";
5import { scaleFactor } from "./render.mjs";
6import { readUnits } from "./recipe-views.mjs";
7
8/** Every procedure response carries it; a save purges it (app/kb/procedures/save.server.ts). */
9export const PROCEDURES_CACHE_TAG = "procedures";
10
11/** The trail above a procedure: its hub, the list it sits in, then itself. */
12export function procedureTrail(record: ProcedureRecord): Array<[string, string]> {
13  if (record.profile === "protocol") {
14    return [
15      ["Research", "/research"],
16      ["Protocols", "/research/protocols"],
17      [record.title, record.path],
18    ];
19  }
20  // A how-to sits under Software and a recipe on its own, each in its base's library (app/kb/libraries.mjs).
21  const base = LIBRARY_BASES.find((b) => b.profile === record.profile);
22  return [...(base ? libraryTrail(base) : []), [record.title, record.path]];
23}
24
25/**
26 * The reader's scale from the URL: `?n=` tubes (or the protocol's unit), `?servings=` for a recipe.
27 * Anything out of range falls back to the file's own count, so a bad link still shows the procedure.
28 */
29export function readScale(record: ProcedureRecord, url: URL) {
30  const raw = record.profile === "recipe" ? url.searchParams.get("servings") : url.searchParams.get("n");
31  const asked = raw === null ? null : Number(raw);
32  const base = record.profile === "recipe" ? (record.servings ?? 1) : (record.scale?.count ?? 1);
33  const valid = asked !== null && Number.isFinite(asked) && asked > 0 && asked <= 1000;
34  const count = valid ? asked : base;
35  // A protocol's steps stay per unit; only its material totals scale, by count. A recipe's steps scale.
36  const factor = record.profile === "recipe" ? scaleFactor(record, count) : 1;
37  // A recipe's amounts in metric or imperial, at its own address (`?units=imperial`), as scaling is (recipe-views.mjs).
38  const units = record.profile === "recipe" ? readUnits(url.searchParams.get("units")) : null;
39  return { count, factor, units };
40}