app/lib/search/ask-keys.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/enhance/ask.ts, app/lib/publications/compile.mjs, app/lib/search/ask-prompt.mjs, app/lib/search/ask.server.ts.

Source

1// AI Search carries nothing but item.key about a chunk's source, so the key IS the citation.
2
3/**
4 * Double underscore: kebab slugs and anchors cannot contain it, but a single one can (posts_fts).
5 */
6export const KEY_SEPARATOR = "__";
7
8/**
9 * The trailing slash is stripped, so a paper's key is exactly its markdown twin's URL.
10 *
11 * @param {string} url `/writing/<slug>`, `/writing/<slug>#<anchor>` or `/research/publications/<slug>/`
12 * @returns {string} `writing/<slug>.md`, `writing/<slug>__<anchor>.md` or `research/publications/<slug>.md`
13 */
14export function keyForUrl(url) {
15  const [path, anchor] = url.replace(/^\//, "").replace(/\/$/, "").split("#");
16  return anchor ? `${path}${KEY_SEPARATOR}${anchor}.md` : `${path}.md`;
17}
18
19/**
20 * Whether an item key is one of this post's: its document key or one of its section keys. Exact key
21 * or section prefix, never startsWith(slug), which would sweep up a longer slug.
22 *
23 * @param {string} slug
24 * @returns {(key: string) => boolean}
25 */
26export function ownsAskKey(slug) {
27  const documentKey = keyForUrl(`/writing/${slug}`);
28  const sectionPrefix = `${documentKey.replace(/\.md$/, "")}${KEY_SEPARATOR}`;
29  return (key) => key === documentKey || key.startsWith(sectionPrefix);
30}
31
32/**
33 * Null for a key this site did not write: an instance can hold items from another source.
34 *
35 * @param {string} key
36 * @returns {string | null}
37 */
38export function urlForKey(key) {
39  if (typeof key !== "string" || !key.endsWith(".md")) return null;
40  const withoutExtension = key.slice(0, -3);
41  const parts = withoutExtension.split(KEY_SEPARATOR);
42  if (parts.length > 2) return null;
43  const [path, anchor] = parts;
44  if (!path) return null;
45  // A paper cites its page, not its twin, with the canonical trailing slash (the slashless form redirects).
46  if (path.startsWith("research/publications/")) return anchor ? null : `/${path}/`;
47  if (!path.startsWith("writing/")) return null;
48  return anchor ? `/${path}#${anchor}` : `/${path}`;
49}
50
51/**
52 * @param {string} key
53 * @returns {string | null}
54 */
55export function slugForKey(key) {
56  const url = urlForKey(key);
57  if (!url) return null;
58  // Posts only: a paper has no posts row, and passing its URL as a slug would make every answer citing
59  // it unreplayable forever.
60  if (!url.startsWith("/writing/")) return null;
61  const slug = (url.split("#")[0] ?? "").replace(/^\/writing\//, "");
62  return slug.length > 0 ? slug : null;
63}
64
65/**
66 * @param {string} url
67 * @returns {string}
68 */
69export function labelForUrl(url) {
70  const [path, anchor] = url.split("#");
71  // The slug, not a DOI: the DOI-to-slug fold is lossy, and a plausible reconstruction is worse than none.
72  if ((path ?? "").startsWith("/research/publications/")) {
73    return `Paper ${(path ?? "").replace(/^\/research\/publications\//, "").replace(/\/$/, "")}`;
74  }
75  const target = anchor ?? (path ?? "").replace(/^\/writing\//, "");
76  const words = target
77    .replace(/^\d+-/, "")
78    .split("-")
79    .filter(Boolean);
80  if (words.length === 0) return "Untitled";
81  return words.join(" ").replace(/^./, (c) => c.toUpperCase());
82}