search: migrate to flexsearch.js for local search

znai-core/src/main/java/org/testingisdocumenting/znai/search/LocalSearchEntries.java

@@ -49,6 +49,6 @@ public List<List<String>> toListOfLists() {
 
     public String buildIndexScript() {
         return "window.znaiSearchData = " + JsonUtils.serialize(toListOfLists()) + "\n" +
-                ResourceUtils.textContent("lunrjs/indexCreation.js");
+                ResourceUtils.textContent("flexsearchjs/indexCreation.js");
     }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/search/SearchCrawlerParserHandler.java

@@ -173,7 +173,7 @@ private void addHighWithSpaceSeparator(String part) {
     }
 
     private String replaceCommonSeparatorsWithSpace(String text) {
-        return text.replaceAll("[.,();:\\-+=\\\\/\"'!?\\[\\]{}]", " ");
+        return text.replaceAll("[.,();:\\-+=\\\\/\"'!?\\[\\]{}~]", " ");
     }
 
     private SearchText createSearchText(SearchScore score, List<String> parts) {

znai-core/src/main/resources/flexsearchjs/indexCreation.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2025 znai maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+window.znaiSearchIdx = window.createLocalSearchIndex();
+window.populateLocalSearchIndexWithData(window.znaiSearchIdx, window.znaiSearchData);

znai-docs/znai/release-notes/1.76/add-2025-05-19-new-local-search-engine.md

@@ -0,0 +1 @@
+* Add: Migrate from [lunrjs](https://github.com/olivernn/lunr.js) to [flexsearchjs](https://github.com/nextapps-de/flexsearch) for local search

znai-reactjs/package.json

@@ -12,8 +12,8 @@
     "diff": "^4.0.2",
     "echarts": "^5.3.2",
     "feather-icons": "^4.28.0",
+    "flexsearch": "^0.8.167",
     "katex": "0.16.21",
-    "lunr": "2.3.9",
     "mark.js": "github:julmot/mark.js",
     "mermaid": "^8.9.2",
     "normalize.css": "^8.0.1",

znai-reactjs/src/doc-elements/search/QueryResult.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2024 znai maintainers
+ * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { SearchResult } from "./flexSearch";
+
+export default class QueryResult {
+  private readonly queryResultsById: Record<string, SearchResult>;
+  constructor(queryResults: SearchResult[]) {
+    this.queryResultsById = queryResults.reduce((acc, searchResult) => {
+      acc[searchResult.id] = searchResult;
+      return acc;
+    }, {} as Record<string, SearchResult>);
+  }
+
+  getIds() {
+    return Object.keys(this.queryResultsById);
+  }
+
+  getSnippetsToHighlight(id: string) {
+    return this.queryResultsById[id].termsToHighlight;
+  }
+}

znai-reactjs/src/doc-elements/search/Search.demo.jsx

@@ -19,6 +19,8 @@ import {getSearchPromise} from "./searchPromise"
 import SearchPopup from "./SearchPopup"
 import {elementsLibrary} from '../DefaultElementsLibrary'
 
+import { setDocMeta } from "../../structure/docMeta.js";
+
 import './testData'
 
 const buttonStyle = {
@@ -31,6 +33,15 @@ const buttonStyle = {
 class SearchDemo extends React.Component {
     state = {isOpen: true}
 
+    componentDidMount() {
+        setDocMeta({
+            id: "preview",
+            title: "Your Product",
+            type: "Guide",
+            previewEnabled: true,
+        });
+    }
+
     render() {
         const { isOpen } = this.state