feat: hook to fetch single meilisearch document

Author: navinkarkera

src/search-manager/data/api.ts

@@ -491,3 +491,18 @@ export async function fetchTagsThatMatchKeyword({
 
   return { matches: Array.from(matches).map((tagPath) => ({ tagPath })), mayBeMissingResults: hits.length === limit };
 }
+
+/**
+ * Fetch single document by its id
+ */
+export async function fetchDocumentById({ client, indexName, id } : {
+  /** The Meilisearch client instance */
+  client: MeiliSearch;
+  /** Which index to search */
+  indexName: string;
+  /** document id */
+  id: string | number;
+}): Promise<ContentHit | CollectionHit> {
+  const doc = await client.index(indexName).getDocument(id);
+  return formatSearchHit(doc);
+}

src/search-manager/data/apiHooks.ts

@@ -240,3 +240,26 @@ export const useTagFilterOptions = (args: {
 
   return { ...mainQuery, data };
 };
+
+export const useGetSingleDocument = ({ client, indexName, id }: {
+  client?: MeiliSearch;
+  indexName?: string;
+  id: string | number;
+}) => (
+  useQuery({
+    enabled: client !== undefined && indexName !== undefined,
+    queryKey: [
+      'content_search',
+      client?.config.apiKey,
+      client?.config.host,
+      indexName,
+      id,
+    ],
+    queryFn: () => {
+      if (client === undefined || indexName === undefined) {
+        throw new Error('Required data unexpectedly undefined. Check "enable" condition of useQuery.');
+      }
+      return fetchDocumentById({ client, indexName, id });
+    },
+  })
+)