quartz-research-note/quartz/components/scripts/search.inline.ts

331 lines
10 KiB
TypeScript
Raw Normal View History

import { Document, SimpleDocumentSearchResultSetUnit } from "flexsearch"
2023-06-20 03:37:45 +00:00
import { ContentDetails } from "../../plugins/emitters/contentIndex"
import { registerEscapeHandler, removeAllChildren } from "./util"
2023-08-21 03:47:07 +00:00
import { FullSlug, resolveRelative } from "../../util/path"
2023-06-20 03:37:45 +00:00
interface Item {
2023-08-12 07:24:30 +00:00
id: number
slug: FullSlug
2023-07-23 00:27:41 +00:00
title: string
content: string
tags: string[]
2023-06-20 03:37:45 +00:00
}
2023-06-20 03:37:45 +00:00
let index: Document<Item> | undefined = undefined
// Can be expanded with things like "term" in the future
type SearchType = "basic" | "tags"
// Current searchType
let searchType: SearchType = "basic"
2023-06-20 03:37:45 +00:00
const contextWindowWords = 30
2023-07-10 02:32:24 +00:00
const numSearchResults = 5
const numTagResults = 3
2023-06-20 03:37:45 +00:00
function highlight(searchTerm: string, text: string, trim?: boolean) {
// try to highlight longest tokens first
2023-07-23 00:27:41 +00:00
const tokenizedTerms = searchTerm
2023-06-20 03:37:45 +00:00
.split(/\s+/)
2023-07-23 00:27:41 +00:00
.filter((t) => t !== "")
.sort((a, b) => b.length - a.length)
let tokenizedText = text.split(/\s+/).filter((t) => t !== "")
2023-06-20 03:37:45 +00:00
let startIndex = 0
let endIndex = tokenizedText.length - 1
if (trim) {
2023-07-23 00:27:41 +00:00
const includesCheck = (tok: string) =>
tokenizedTerms.some((term) => tok.toLowerCase().startsWith(term.toLowerCase()))
2023-06-20 03:37:45 +00:00
const occurencesIndices = tokenizedText.map(includesCheck)
let bestSum = 0
let bestIndex = 0
for (let i = 0; i < Math.max(tokenizedText.length - contextWindowWords, 0); i++) {
const window = occurencesIndices.slice(i, i + contextWindowWords)
const windowSum = window.reduce((total, cur) => total + (cur ? 1 : 0), 0)
if (windowSum >= bestSum) {
bestSum = windowSum
bestIndex = i
}
}
startIndex = Math.max(bestIndex - contextWindowWords, 0)
endIndex = Math.min(startIndex + 2 * contextWindowWords, tokenizedText.length - 1)
tokenizedText = tokenizedText.slice(startIndex, endIndex)
}
2023-07-23 00:27:41 +00:00
const slice = tokenizedText
.map((tok) => {
// see if this tok is prefixed by any search terms
for (const searchTok of tokenizedTerms) {
if (tok.toLowerCase().includes(searchTok.toLowerCase())) {
const regex = new RegExp(searchTok.toLowerCase(), "gi")
return tok.replace(regex, `<span class="highlight">$&</span>`)
}
2023-06-20 03:37:45 +00:00
}
2023-07-23 00:27:41 +00:00
return tok
})
2023-06-20 03:37:45 +00:00
.join(" ")
2023-08-21 03:48:35 +00:00
return `${startIndex === 0 ? "" : "..."}${slice}${
endIndex === tokenizedText.length - 1 ? "" : "..."
}`
2023-06-20 03:37:45 +00:00
}
const encoder = (str: string) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/)
2023-08-21 03:47:07 +00:00
let prevShortcutHandler: ((e: HTMLElementEventMap["keydown"]) => void) | undefined = undefined
2023-06-20 03:37:45 +00:00
document.addEventListener("nav", async (e: unknown) => {
const currentSlug = (e as CustomEventMap["nav"]).detail.url
const data = await fetchData
const container = document.getElementById("search-container")
2023-07-05 00:14:15 +00:00
const sidebar = container?.closest(".sidebar") as HTMLElement
2023-06-20 03:37:45 +00:00
const searchIcon = document.getElementById("search-icon")
const searchBar = document.getElementById("search-bar") as HTMLInputElement | null
const results = document.getElementById("results-container")
const idDataMap = Object.keys(data) as FullSlug[]
2023-06-20 03:37:45 +00:00
function hideSearch() {
container?.classList.remove("active")
if (searchBar) {
searchBar.value = "" // clear the input when we dismiss the search
}
2023-07-05 00:14:15 +00:00
if (sidebar) {
sidebar.style.zIndex = "unset"
}
2023-06-20 03:37:45 +00:00
if (results) {
removeAllChildren(results)
}
searchType = "basic" // reset search type after closing
2023-06-20 03:37:45 +00:00
}
function showSearch(searchTypeNew: SearchType) {
searchType = searchTypeNew
2023-07-05 00:14:15 +00:00
if (sidebar) {
sidebar.style.zIndex = "1"
}
2023-06-20 03:37:45 +00:00
container?.classList.add("active")
searchBar?.focus()
}
function shortcutHandler(e: HTMLElementEventMap["keydown"]) {
if (e.key === "k" && (e.ctrlKey || e.metaKey) && !e.shiftKey) {
e.preventDefault()
const searchBarOpen = container?.classList.contains("active")
searchBarOpen ? hideSearch() : showSearch("basic")
} else if (e.shiftKey && (e.ctrlKey || e.metaKey) && e.key.toLowerCase() === "k") {
// Hotkey to open tag search
2023-06-20 03:37:45 +00:00
e.preventDefault()
const searchBarOpen = container?.classList.contains("active")
searchBarOpen ? hideSearch() : showSearch("tags")
// add "#" prefix for tag search
if (searchBar) searchBar.value = "#"
2023-06-20 03:37:45 +00:00
} else if (e.key === "Enter") {
const anchor = document.getElementsByClassName("result-card")[0] as HTMLInputElement | null
if (anchor) {
anchor.click()
}
}
}
function trimContent(content: string) {
// works without escaping html like in `description.ts`
const sentences = content.replace(/\s+/g, " ").split(".")
let finalDesc = ""
let sentenceIdx = 0
// Roughly estimate characters by (words * 5). Matches description length in `description.ts`.
const len = contextWindowWords * 5
while (finalDesc.length < len) {
const sentence = sentences[sentenceIdx]
if (!sentence) break
finalDesc += sentence + "."
sentenceIdx++
}
// If more content would be available, indicate it by finishing with "..."
if (finalDesc.length < content.length) {
finalDesc += ".."
}
return finalDesc
}
2023-08-12 07:24:30 +00:00
const formatForDisplay = (term: string, id: number) => {
const slug = idDataMap[id]
return {
id,
slug,
title: highlight(term, data[slug].title ?? ""),
// if searchType is tag, display context from start of file and trim, otherwise use regular highlight
content:
searchType === "tags"
? trimContent(data[slug].content)
: highlight(term, data[slug].content ?? "", true),
tags: highlightTags(term, data[slug].tags),
}
}
function highlightTags(term: string, tags: string[]) {
if (tags && searchType === "tags") {
// Find matching tags
const termLower = term.toLowerCase()
let matching = tags.filter((str) => str.includes(termLower))
// Substract matching from original tags, then push difference
if (matching.length > 0) {
let difference = tags.filter((x) => !matching.includes(x))
// Convert to html (cant be done later as matches/term dont get passed to `resultToHTML`)
matching = matching.map((tag) => `<li><p class="match-tag">#${tag}</p></li>`)
difference = difference.map((tag) => `<li><p>#${tag}</p></li>`)
matching.push(...difference)
}
// Only allow max of `numTagResults` in preview
if (tags.length > numTagResults) {
matching.splice(numTagResults)
}
return matching
} else {
return []
2023-08-12 07:24:30 +00:00
}
}
2023-06-20 03:37:45 +00:00
const resultToHTML = ({ slug, title, content, tags }: Item) => {
const htmlTags = tags.length > 0 ? `<ul>${tags.join("")}</ul>` : ``
2023-06-20 03:37:45 +00:00
const button = document.createElement("button")
button.classList.add("result-card")
button.id = slug
button.innerHTML = `<h3>${title}</h3>${htmlTags}<p>${content}</p>`
2023-07-23 00:27:41 +00:00
button.addEventListener("click", () => {
const targ = resolveRelative(currentSlug, slug)
window.spaNavigate(new URL(targ, window.location.toString()))
2023-08-27 00:19:45 +00:00
hideSearch()
2023-06-20 03:37:45 +00:00
})
return button
}
function displayResults(finalResults: Item[]) {
if (!results) return
removeAllChildren(results)
if (finalResults.length === 0) {
results.innerHTML = `<button class="result-card">
<h3>No results.</h3>
<p>Try another search term?</p>
</button>`
} else {
results.append(...finalResults.map(resultToHTML))
}
}
2023-08-12 07:03:11 +00:00
async function onType(e: HTMLElementEventMap["input"]) {
let term = (e.target as HTMLInputElement).value
let searchResults: SimpleDocumentSearchResultSetUnit[]
if (term.toLowerCase().startsWith("#")) {
searchType = "tags"
} else {
searchType = "basic"
}
switch (searchType) {
case "tags": {
term = term.substring(1)
searchResults =
(await index?.searchAsync({ query: term, limit: numSearchResults, index: ["tags"] })) ??
[]
break
}
case "basic":
default: {
searchResults =
(await index?.searchAsync({
query: term,
limit: numSearchResults,
index: ["title", "content"],
})) ?? []
}
}
2023-08-12 07:24:30 +00:00
const getByField = (field: string): number[] => {
2023-06-20 03:37:45 +00:00
const results = searchResults.filter((x) => x.field === field)
2023-08-12 07:24:30 +00:00
return results.length === 0 ? [] : ([...results[0].result] as number[])
2023-06-20 03:37:45 +00:00
}
// order titles ahead of content
const allIds: Set<number> = new Set([
...getByField("title"),
...getByField("content"),
...getByField("tags"),
])
2023-07-23 00:27:41 +00:00
const finalResults = [...allIds].map((id) => formatForDisplay(term, id))
2023-06-20 03:37:45 +00:00
displayResults(finalResults)
}
2023-08-21 03:47:07 +00:00
if (prevShortcutHandler) {
document.removeEventListener("keydown", prevShortcutHandler)
}
2023-06-20 03:37:45 +00:00
document.addEventListener("keydown", shortcutHandler)
2023-08-21 03:47:07 +00:00
prevShortcutHandler = shortcutHandler
searchIcon?.removeEventListener("click", () => showSearch("basic"))
searchIcon?.addEventListener("click", () => showSearch("basic"))
2023-06-20 03:37:45 +00:00
searchBar?.removeEventListener("input", onType)
searchBar?.addEventListener("input", onType)
2023-07-05 00:14:15 +00:00
// setup index if it hasn't been already
if (!index) {
index = new Document({
cache: true,
2023-07-23 00:27:41 +00:00
charset: "latin:extra",
optimize: true,
encode: encoder,
document: {
2023-08-12 07:24:30 +00:00
id: "id",
index: [
{
field: "title",
2023-08-12 07:24:30 +00:00
tokenize: "reverse",
},
{
field: "content",
tokenize: "reverse",
},
{
field: "tags",
tokenize: "reverse",
},
2023-07-23 00:27:41 +00:00
],
},
})
fillDocument(index, data)
}
2023-06-20 03:37:45 +00:00
// register handlers
registerEscapeHandler(container, hideSearch)
})
/**
* Fills flexsearch document with data
* @param index index to fill
* @param data data to fill index with
*/
async function fillDocument(index: Document<Item, false>, data: any) {
let id = 0
for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
await index.addAsync(id, {
id,
slug: slug as FullSlug,
title: fileData.title,
content: fileData.content,
tags: fileData.tags,
})
id++
}
}