@myst-theme/search-minisearch 0.0.0

package/README.md

@@ -0,0 +1,3 @@
+# @myst-theme/search-minisearch
+
+A minisearch implementation for client-side searching in MyST sites.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { type Options, type SearchResult as MiniSearchResult } from 'minisearch';
+import type { SearchRecord, SearchResult, ISearch } from '@myst-theme/search';
+export type ExtendedOptions = Options & Required<Pick<Options, 'tokenize' | 'processTerm'>>;
+export declare function prepareOptions(options: Options): ExtendedOptions;
+export type RawSearchResult = SearchRecord & MiniSearchResult;
+export declare function combineResults(results: Map<string, Map<string, RawSearchResult>>): SearchResult[];
+export declare function createSearch(documents: SearchRecord[], options: Options): ISearch;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAmB,EAAE,KAAK,OAAO,EAAE,KAAK,YAAY,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAG9E,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC;AAE5F,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe,CAOhE;AAED,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,gBAAgB,CAAC;AAE9D,wBAAgB,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,GAAG,YAAY,EAAE,CAiDjG;AAED,wBAAgB,YAAY,CAAC,SAAS,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAqBjF"}

package/dist/index.js

@@ -0,0 +1,74 @@
+import MiniSearch from 'minisearch';
+import { extractField } from '@myst-theme/search';
+export function prepareOptions(options) {
+    return {
+        ...options,
+        tokenize: MiniSearch.getDefault('tokenize'),
+        processTerm: MiniSearch.getDefault('processTerm'),
+        extractField,
+    };
+}
+export function combineResults(results) {
+    const [firstEntry, ...restEntries] = results.entries();
+    if (firstEntry === undefined) {
+        return [];
+    }
+    // Transform from { terms, queryTerms, match} to [ { term, matches} ]
+    const firstRawResults = firstEntry[1];
+    const initialValue = new Map(Array.from(firstRawResults.entries(), ([id, rawResult]) => {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { id: _, score, terms, queryTerms, match, ...rest } = rawResult;
+        return [
+            id,
+            {
+                id,
+                queries: [
+                    {
+                        term: queryTerms[0],
+                        matches: match,
+                    },
+                ],
+                ...rest,
+            },
+        ];
+    }));
+    // Reduce all entries with this transform
+    const mergedResults = restEntries.reduce((accumulator, value) => {
+        const nextAccumulator = new Map();
+        const rawResults = value[1];
+        rawResults.forEach((rawResult, docID) => {
+            const existing = accumulator.get(docID);
+            if (existing == null) {
+                return;
+            }
+            const { queryTerms, match } = rawResult;
+            existing.queries.push({
+                term: queryTerms[0],
+                matches: match,
+            });
+            nextAccumulator.set(docID, existing);
+        });
+        return nextAccumulator;
+    }, initialValue);
+    return Array.from(mergedResults.values());
+}
+export function createSearch(documents, options) {
+    const extendedOptions = prepareOptions(options);
+    const search = new MiniSearch(extendedOptions);
+    search.addAll(documents.map((doc, index) => ({ ...doc, id: index })));
+    return async (query) => {
+        // Implement executeQuery whilst retaining distinction between terms
+        // TODO: should we check for unique terms?
+        const terms = extendedOptions.tokenize(query).filter((token) => !!token);
+        if (!terms.length) {
+            return undefined;
+        }
+        else {
+            const termResults = new Map(terms.map((term) => [
+                term,
+                new Map(search.search(term).map((doc) => [doc.id, doc])),
+            ]));
+            return combineResults(termResults);
+        }
+    };
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@myst-theme/search-minisearch",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rimraf dist",
+    "lint": "eslint \"src/**/*.ts*\" -c ./.eslintrc.cjs",
+    "lint:format": "prettier --check \"src/**/*.{ts,tsx,md}\"",
+    "build:esm": "tsc --project ./tsconfig.json --module Node16 --outDir dist --declaration",
+    "build": "npm-run-all -l clean -p build:esm"
+  },
+  "dependencies": {
+    "@myst-theme/search": "^0.0.0",
+    "minisearch": "^7.1.0"
+  }
+}