aboutsummaryrefslogtreecommitdiffstats
path: root/packages/shared/search.ts
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2025-07-27 19:37:11 +0100
committerMohamedBassem <me@mbassem.com>2025-07-27 19:37:11 +0100
commitb94896a0f8fa43b957a9bdd6ab57ada0ab8101af (patch)
treeed8f79ce7d407379fa0d8210db52959f849fac0e /packages/shared/search.ts
parent7bb7f18fbf8e374efde2fe28bacfc29157b9fa19 (diff)
downloadkarakeep-b94896a0f8fa43b957a9bdd6ab57ada0ab8101af.tar.zst
refactor: Extract meilisearch as a plugin
Diffstat (limited to 'packages/shared/search.ts')
-rw-r--r--packages/shared/search.ts90
1 files changed, 28 insertions, 62 deletions
diff --git a/packages/shared/search.ts b/packages/shared/search.ts
index 2c6904b2..2afc9763 100644
--- a/packages/shared/search.ts
+++ b/packages/shared/search.ts
@@ -1,10 +1,8 @@
-import type { Index } from "meilisearch";
-import { MeiliSearch } from "meilisearch";
import { z } from "zod";
-import serverConfig from "./config";
+import { PluginManager, PluginType } from "./plugins";
-export const zBookmarkIdxSchema = z.object({
+export const zBookmarkSearchDocument = z.object({
id: z.string(),
userId: z.string(),
url: z.string().nullish(),
@@ -24,68 +22,36 @@ export const zBookmarkIdxSchema = z.object({
dateModified: z.date().nullish(),
});
-export type ZBookmarkIdx = z.infer<typeof zBookmarkIdxSchema>;
+export type BookmarkSearchDocument = z.infer<typeof zBookmarkSearchDocument>;
-let searchClient: MeiliSearch | undefined;
-
-if (serverConfig.search.meilisearch) {
- searchClient = new MeiliSearch({
- host: serverConfig.search.meilisearch.address,
- apiKey: serverConfig.search.meilisearch.key,
- });
+export interface SearchResult {
+ id: string;
+ score?: number;
}
-const BOOKMARKS_IDX_NAME = "bookmarks";
-
-let idxClient: Index<ZBookmarkIdx> | undefined;
-
-export async function getSearchIdxClient(): Promise<Index<ZBookmarkIdx> | null> {
- if (idxClient) {
- return idxClient;
- }
- if (!searchClient) {
- return null;
- }
-
- const indicies = await searchClient.getIndexes();
- let idxFound = indicies.results.find((i) => i.uid == BOOKMARKS_IDX_NAME);
- if (!idxFound) {
- const idx = await searchClient.createIndex(BOOKMARKS_IDX_NAME, {
- primaryKey: "id",
- });
- await searchClient.waitForTask(idx.taskUid);
- idxFound = await searchClient.getIndex<ZBookmarkIdx>(BOOKMARKS_IDX_NAME);
- }
+export interface SearchOptions {
+ query: string;
+ filter?: string[];
+ limit?: number;
+ offset?: number;
+ sort?: string[];
+}
- const desiredFilterableAttributes = ["id", "userId"].sort();
- const desiredSortableAttributes = ["createdAt"].sort();
+export interface SearchResponse {
+ hits: SearchResult[];
+ totalHits: number;
+ processingTimeMs: number;
+}
- const settings = await idxFound.getSettings();
- if (
- JSON.stringify(settings.filterableAttributes?.sort()) !=
- JSON.stringify(desiredFilterableAttributes)
- ) {
- console.log(
- `[meilisearch] Updating desired filterable attributes to ${desiredFilterableAttributes} from ${settings.filterableAttributes}`,
- );
- const taskId = await idxFound.updateFilterableAttributes(
- desiredFilterableAttributes,
- );
- await searchClient.waitForTask(taskId.taskUid);
- }
+export interface SearchIndexClient {
+ addDocuments(documents: BookmarkSearchDocument[]): Promise<void>;
+ updateDocuments(documents: BookmarkSearchDocument[]): Promise<void>;
+ deleteDocument(id: string): Promise<void>;
+ deleteDocuments(ids: string[]): Promise<void>;
+ search(options: SearchOptions): Promise<SearchResponse>;
+ clearIndex(): Promise<void>;
+}
- if (
- JSON.stringify(settings.sortableAttributes?.sort()) !=
- JSON.stringify(desiredSortableAttributes)
- ) {
- console.log(
- `[meilisearch] Updating desired sortable attributes to ${desiredSortableAttributes} from ${settings.sortableAttributes}`,
- );
- const taskId = await idxFound.updateSortableAttributes(
- desiredSortableAttributes,
- );
- await searchClient.waitForTask(taskId.taskUid);
- }
- idxClient = idxFound;
- return idxFound;
+export async function getSearchClient(): Promise<SearchIndexClient | null> {
+ return PluginManager.getClient(PluginType.Search);
}