Add experimental Search Feature

src/components/types/pagefind.ts

@@ -0,0 +1,65 @@
+/*
+ *   This file is a part of the SteamWar software.
+ *
+ *   Copyright (C) 2024 SteamWar.de-Serverteam
+ *
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU Affero General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *   GNU Affero General Public License for more details.
+ *
+ *   You should have received a copy of the GNU Affero General Public License
+ *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+export interface Pagefind {
+    search: (query: string) => Promise<PagefindResponse>;
+    debouncedSearch: (query: string) => Promise<PagefindResponse>;
+    init: () => void;
+}
+
+export interface PagefindResponse {
+    results: PagefindResult[];
+}
+
+export interface PagefindResult {
+    id: string;
+    data: () => Promise<PagefindDocument>;
+}
+
+export interface PagefindDocument {
+    url: string;
+    excerpt: string;
+    filters: {
+        author: string;
+    };
+    meta: {
+        title: string;
+        image: string;
+    };
+    content: string;
+    word_count: number;
+    sub_results: PagefindSubresult[];
+}
+
+export interface PagefindSubresult {
+    excerpt: string;
+    title: string;
+    url: string;
+}
+
+declare global {
+    interface Window {
+        pagefind: Pagefind;
+    }
+}
+
+export async function importPagefind(): Promise<Pagefind> {
+    const url = "/pagefind/pagefind.js";
+    return await import(/* @vite-ignore */ url);
+}