@brett_lamy/docstream 1.18.1 → 1.19.1

package/dist/site/search.js

@@ -0,0 +1,125 @@
+/* Client-side full-text search over a docs tree: each page is split into sections at its
+   headings, so a hit can jump straight to the heading it was found under. */
+import { slugify } from "../gitbook/outline.js";
+import { plainTitle } from "./tree.js";
+const HEADING = /^(#{1,6})[ \t]+(.+?)[ \t]*#*[ \t]*$/;
+const TABS_TITLE = /^\{%\s*tabs\b[^%]*\btitle="([^"]+)"/;
+/** Markdown → searchable plain text (tags, HTML and punctuation removed, code kept). */
+export function searchableText(markdown) {
+    return markdown
+        .replace(/^(`{3,}|~{3,}).*$/gm, " ")
+        .replace(/\{%[^%]*%\}/g, " ")
+        .replace(/<[^>]+>/g, " ")
+        .replace(/!\[([^\]]*)\]\([^)]*\)/g, "$1")
+        .replace(/\[([^\]]*)\]\([^)]*\)/g, "$1")
+        .replace(/^\[\^[^\]]+\]:.*$/gm, " ")
+        .replace(/\[\^[^\]]+\]/g, "")
+        .replace(/[*~`>|#]+/g, " ")
+        // `_` only as emphasis at a word's edge, so `@brett_lamy` and `snake_case` stay whole.
+        .replace(/(^|[\s(])_+|_+(?=[\s).,;:!?]|$)/g, "$1 ")
+        .replace(/^\s*[-+]\s+(\[.\]\s+)?/gm, " ")
+        .replace(/\$\$/g, " ")
+        .replace(/\s+/g, " ")
+        .trim();
+}
+function sectionsOf(page) {
+    const out = [];
+    let heading;
+    let buf = [];
+    let fence = null;
+    const flush = () => {
+        const text = searchableText(buf.join("\n"));
+        if (text || heading)
+            out.push({ page, heading, anchor: heading ? slugify(heading) : undefined, text });
+        buf = [];
+    };
+    for (const line of page.body.split("\n")) {
+        const trimmed = line.trim();
+        const f = /^(`{3,}|~{3,})/.exec(trimmed);
+        if (f) {
+            if (!fence)
+                fence = f[1][0];
+            else if (f[1][0] === fence)
+                fence = null;
+            buf.push(line);
+            continue;
+        }
+        const h = fence ? null : HEADING.exec(line) ?? TABS_TITLE.exec(trimmed);
+        if (h) {
+            flush();
+            heading = plainTitle(h.length === 3 ? h[2] : h[1]);
+            continue;
+        }
+        buf.push(line);
+    }
+    flush();
+    return out;
+}
+function snippetAround(text, at, length) {
+    if (at < 0)
+        return { snippet: text.length > 140 ? `${text.slice(0, 140).trimEnd()}…` : text };
+    const start = Math.max(0, at - 50);
+    const end = Math.min(text.length, at + length + 90);
+    const lead = start > 0 ? "…" : "";
+    const snippet = `${lead}${text.slice(start, end).trim()}${end < text.length ? "…" : ""}`;
+    const offset = lead.length + (at - start) - (text.slice(start, end).length - text.slice(start, end).trimStart().length);
+    return { snippet, highlight: [offset, offset + length] };
+}
+/** An in-memory index of every page; `search` ranks title, then heading, then body matches. */
+export function createDocsSearchIndex(tree) {
+    const sections = tree.pages.flatMap(sectionsOf);
+    return {
+        sections,
+        search(query, limit = 20) {
+            const q = query.trim().toLowerCase();
+            if (!q)
+                return [];
+            const terms = q.split(/\s+/).filter(Boolean);
+            const results = [];
+            for (const s of sections) {
+                const title = s.page.title.toLowerCase();
+                const heading = s.heading?.toLowerCase() ?? "";
+                const text = s.text.toLowerCase();
+                const haystack = `${title} ${heading} ${text}`;
+                if (!terms.every((t) => haystack.includes(t)))
+                    continue;
+                let score = 0;
+                for (const t of terms) {
+                    if (title.startsWith(t))
+                        score += 12;
+                    else if (title.includes(t))
+                        score += 8;
+                    if (heading.startsWith(t))
+                        score += 6;
+                    else if (heading.includes(t))
+                        score += 4;
+                    if (text.includes(t))
+                        score += 1;
+                }
+                if (title === q)
+                    score += 20;
+                if (heading === q)
+                    score += 10;
+                // A page's opening section carries its title match; deeper sections rank by their heading.
+                if (s.heading)
+                    score -= title.includes(terms[0]) ? 6 : 0;
+                const at = text.indexOf(terms[0]);
+                results.push({ page: s.page, heading: s.heading, anchor: s.anchor, score, ...snippetAround(s.text, at, at >= 0 ? terms[0].length : 0) });
+            }
+            results.sort((a, b) => b.score - a.score);
+            const seen = new Set();
+            const out = [];
+            for (const r of results) {
+                const key = `${r.page.slug}#${r.anchor ?? ""}`;
+                if (seen.has(key))
+                    continue;
+                seen.add(key);
+                out.push(r);
+                if (out.length >= limit)
+                    break;
+            }
+            return out;
+        },
+    };
+}
+//# sourceMappingURL=search.js.map

package/dist/site/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/site/search.ts"],"names":[],"mappings":"AAAA;6EAC6E;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAgC,MAAM,QAAQ,CAAA;AA2BjE,MAAM,OAAO,GAAG,qCAAqC,CAAA;AACrD,MAAM,UAAU,GAAG,qCAAqC,CAAA;AAExD,wFAAwF;AACxF,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,OAAO,QAAQ;SACZ,OAAO,CAAC,qBAAqB,EAAE,GAAG,CAAC;SACnC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC;SAC5B,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,yBAAyB,EAAE,IAAI,CAAC;SACxC,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC;SACvC,OAAO,CAAC,qBAAqB,EAAE,GAAG,CAAC;SACnC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;SAC5B,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC;QAC3B,uFAAuF;SACtF,OAAO,CAAC,kCAAkC,EAAE,KAAK,CAAC;SAClD,OAAO,CAAC,0BAA0B,EAAE,GAAG,CAAC;SACxC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,IAAI,EAAE,CAAA;AACX,CAAC;AAED,SAAS,UAAU,CAAC,IAAc;IAChC,MAAM,GAAG,GAAwB,EAAE,CAAA;IACnC,IAAI,OAA2B,CAAA;IAC/B,IAAI,GAAG,GAAa,EAAE,CAAA;IACtB,IAAI,KAAK,GAAkB,IAAI,CAAA;IAC/B,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAC3C,IAAI,IAAI,IAAI,OAAO;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACtG,GAAG,GAAG,EAAE,CAAA;IACV,CAAC,CAAA;IACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;QAC3B,MAAM,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACxC,IAAI,CAAC,EAAE,CAAC;YACN,IAAI,CAAC,KAAK;gBAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAE,CAAA;iBACxB,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,KAAK,KAAK;gBAAE,KAAK,GAAG,IAAI,CAAA;YACzC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACd,SAAQ;QACV,CAAC;QACD,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvE,IAAI,CAAC,EAAE,CAAC;YACN,KAAK,EAAE,CAAA;YACP,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAA;YACpD,SAAQ;QACV,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IACD,KAAK,EAAE,CAAA;IACP,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc;IAC7D,IAAI,EAAE,GAAG,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC7F,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA;IAClC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,EAAE,CAAC,CAAA;IACnD,MAAM,IAAI,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACjC,MAAM,OAAO,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IACxF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAA;IACvH,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;AAC1D,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,qBAAqB,CAAC,IAAc;IAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAC/C,OAAO;QACL,QAAQ;QACR,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,EAAE;YACtB,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;YACpC,IAAI,CAAC,CAAC;gBAAE,OAAO,EAAE,CAAA;YACjB,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC5C,MAAM,OAAO,GAAuB,EAAE,CAAA;YACtC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;gBACzB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAA;gBACxC,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;gBAC9C,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;gBACjC,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,OAAO,IAAI,IAAI,EAAE,CAAA;gBAC9C,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAAE,SAAQ;gBACvD,IAAI,KAAK,GAAG,CAAC,CAAA;gBACb,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;oBACtB,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;wBAAE,KAAK,IAAI,EAAE,CAAA;yBAC/B,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;wBAAE,KAAK,IAAI,CAAC,CAAA;oBACtC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;wBAAE,KAAK,IAAI,CAAC,CAAA;yBAChC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;wBAAE,KAAK,IAAI,CAAC,CAAA;oBACxC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;wBAAE,KAAK,IAAI,CAAC,CAAA;gBAClC,CAAC;gBACD,IAAI,KAAK,KAAK,CAAC;oBAAE,KAAK,IAAI,EAAE,CAAA;gBAC5B,IAAI,OAAO,KAAK,CAAC;oBAAE,KAAK,IAAI,EAAE,CAAA;gBAC9B,2FAA2F;gBAC3F,IAAI,CAAC,CAAC,OAAO;oBAAE,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;gBACzD,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAA;gBAClC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAC3I,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAA;YACzC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;YAC9B,MAAM,GAAG,GAAuB,EAAE,CAAA;YAClC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;gBACxB,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,CAAA;gBAC9C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,SAAQ;gBAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBACb,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACX,IAAI,GAAG,CAAC,MAAM,IAAI,KAAK;oBAAE,MAAK;YAChC,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC;KACF,CAAA;AACH,CAAC"}