app/kb/search-bases.mjs

Functions

Imports

It imports app/kb/bases.mjs, app/kb/registry/catalog.mjs. Imported by app/lib/search/search.server.ts, app/routes/search.tsx.

Source

1// The knowledge base facet of the site's search (docs/KNOWLEDGE-BASE.md, step 8, finding A2): one search across every knowledge
2// base, narrowed to one of them by its entries' address. Each base's entries live under its entry root (bases.mjs) and the lab
3// registry's items under /research/lab, so a record's base is read from its address and never stored on the record. Each
4// library keeps its own facets; this is the one the search adds.
5
6import { BASES } from "./bases.mjs";
7import { LAB_PATH } from "./registry/catalog.mjs";
8
9/** The facet's values in the order the search lists them: each knowledge base, then the lab registry. */
10export const SEARCH_BASES = Object.freeze([
11  ...BASES.map((base) => ({ id: base.id, label: base.name, prefix: base.entryRoot })),
12  { id: "lab", label: "Lab registry", prefix: `${LAB_PATH}/` },
13]);
14
15/** The base a search record belongs to, from its address, or null for a record in no base. @param {string} url */
16export function baseOfUrl(url) {
17  return SEARCH_BASES.find((base) => url.startsWith(base.prefix))?.id ?? null;
18}
19
20/** A base's words, for its facet chip; an id no base has is shown as typed. @param {string} id */
21export function baseLabel(id) {
22  return SEARCH_BASES.find((base) => base.id === id)?.label ?? id;
23}
24
25/** The address prefix of a base, or null for an id no base has. @param {string} id */
26export function basePrefix(id) {
27  return SEARCH_BASES.find((base) => base.id === id)?.prefix ?? null;
28}