/* * Copyright (c) 2016-2023 Martin Donath * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to * deal in the Software without restriction, including without limitation the * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or * sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A RTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS * IN THE SOFTWARE. */ import lunr from "lunr" import { getElement } from "~/browser/element/_" import "~/polyfills" import { Search } from "../../_" import { SearchConfig } from "../../config" import { SearchMessage, SearchMessageType } from "../message" /* ---------------------------------------------------------------------------- * Types * ------------------------------------------------------------------------- */ /** * Add support for `iframe-worker` shim * * While `importScripts` is synchronous when executed inside of a web worker, * it's not possible to provide a synchronous shim implementation. The cool * thing is that awaiting a non-Promise will convert it into a Promise, so * extending the type definition to return a `Promise` shouldn't break anything. * * @see https://bit.ly/2PjDnXi - GitHub comment * * @param urls - Scripts to load * * @returns Promise resolving with no result */ declare global { function importScripts(...urls: string[]): Promise | void } /* ---------------------------------------------------------------------------- * Data * ------------------------------------------------------------------------- */ /** * Search index */ let index: Search /* ---------------------------------------------------------------------------- * Helper functions * ------------------------------------------------------------------------- */ /** * Fetch (= import) multi-language support through `lunr-languages` * * This function automatically imports the stemmers necessary to process the * languages which are defined as part of the search configuration. * * If the worker runs inside of an `iframe` (when using `iframe-worker` as * a shim), the base URL for the stemmers to be loaded must be determined by * searching for the first `script` element with a `src` attribute, which will * contain the contents of this script. * * @param config - Search configuration * * @returns Promise resolving with no result */ async function setupSearchLanguages( config: SearchConfig ): Promise { let base = "../lunr" /* Detect `iframe-worker` and fix base URL */ if (typeof parent !== "undefined" && "IFrameWorker" in parent) { const worker = getElement("script[src]")! const [path] = worker.src.split("/worker") /* Prefix base with path */ base = base.replace("..", path) } /* Add scripts for languages */ const scripts = [] for (const lang of config.lang) { switch (lang) { /* Add segmenter for Japanese */ case "ja": scripts.push(`${base}/tinyseg.js`) break /* Add segmenter for Hindi and Thai */ case "hi": case "th": scripts.push(`${base}/wordcut.js`) break } /* Add language support */ if (lang !== "en") scripts.push(`${base}/min/lunr.${lang}.min.js`) } /* Add multi-language support */ if (config.lang.length > 1) scripts.push(`${base}/min/lunr.multi.min.js`) /* Load scripts synchronously */ if (scripts.length) await importScripts( `${base}/min/lunr.stemmer.support.min.js`, ...scripts ) } /* ---------------------------------------------------------------------------- * Functions * ------------------------------------------------------------------------- */ /** * Message handler * * @param message - Source message * * @returns Target message */ export async function handler( message: SearchMessage ): Promise { switch (message.type) { /* Search setup message */ case SearchMessageType.SETUP: await setupSearchLanguages(message.data.config) index = new Search(message.data) return { type: SearchMessageType.READY } /* Search query message */ case SearchMessageType.QUERY: const query = message.data try { return { type: SearchMessageType.RESULT, data: index.search(query) } /* Return empty result in case of error */ } catch (err) { console.warn(`Invalid query: ${query} – see https://bit.ly/2s3ChXG`) console.warn(err) return { type: SearchMessageType.RESULT, data: { items: [] } } } /* All other messages */ default: throw new TypeError("Invalid message type") } } /* ---------------------------------------------------------------------------- * Worker * ------------------------------------------------------------------------- */ /* Expose Lunr.js in global scope, or stemmers won't work */ self.lunr = lunr /* Handle messages */ addEventListener("message", async ev => { postMessage(await handler(ev.data)) })