Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

2.1 KB
Raw Blame
import { z } from "zod";

import { PluginManager, PluginType } from "./plugins";

export const zBookmarkSearchDocument = z.object({
  id: z.string(),
  userId: z.string(),
  url: z.string().nullish(),
  title: z.string().nullish(),
  linkTitle: z.string().nullish(),
  description: z.string().nullish(),
  content: z.string().nullish(),
  metadata: z.string().nullish(),
  fileName: z.string().nullish(),
  createdAt: z.string().nullish(),
  note: z.string().nullish(),
  summary: z.string().nullish(),
  tags: z.array(z.string()).default([]),
  publisher: z.string().nullish(),
  author: z.string().nullish(),
  datePublished: z.date().nullish(),
  dateModified: z.date().nullish(),
});

export type BookmarkSearchDocument = z.infer<typeof zBookmarkSearchDocument>;

export type SortOrder = "asc" | "desc";
export type SortableAttributes = "createdAt";

export type FilterableAttributes = "userId" | "id";
export type FilterQuery =
  | {
      type: "eq";
      field: FilterableAttributes;
      value: string;
    }
  | {
      type: "in";
      field: FilterableAttributes;
      values: string[];
    };

export interface SearchResult {
  id: string;
  score?: number;
}

export interface SearchOptions {
  query: string;
  // Diffeernt filters are ANDed together
  filter?: FilterQuery[];
  limit?: number;
  offset?: number;
  sort?: { field: SortableAttributes; order: SortOrder }[];
}

export interface SearchResponse {
  hits: SearchResult[];
  totalHits: number;
  processingTimeMs: number;
}

export interface IndexingOptions {
  /**
   * Whether to batch requests. Defaults to true.
   * Set to false to bypass batching for improved reliability (e.g., on retries).
   */
  batch?: boolean;
}

export interface SearchIndexClient {
  addDocuments(
    documents: BookmarkSearchDocument[],
    options?: IndexingOptions,
  ): Promise<void>;
  deleteDocuments(ids: string[], options?: IndexingOptions): Promise<void>;
  search(options: SearchOptions): Promise<SearchResponse>;
  clearIndex(): Promise<void>;
}

export async function getSearchClient(): Promise<SearchIndexClient | null> {
  return PluginManager.getClient(PluginType.Search);
}