feat: add global search

src/api/item.ts

@@ -16,6 +16,7 @@ import {
 } from '../types.js';
 import { verifyAuthentication } from './axios.js';
 import {
+  AccessibleItemSearchParams,
   GET_OWN_ITEMS_ROUTE,
   GET_RECYCLED_ITEMS_DATA_ROUTE,
   ItemChildrenParams,
@@ -38,6 +39,7 @@ import {
   buildPostItemWithThumbnailRoute,
   buildRecycleItemsRoute,
   buildRestoreItemsRoute,
+  buildSearchItems,
 } from './routes.js';
 
 export const getItem = (
@@ -67,7 +69,7 @@ export const getOwnItems = async ({
   );
 
 export const getAccessibleItems = async (
-  params: ItemSearchParams,
+  params: AccessibleItemSearchParams,
   pagination: PaginationParams,
   { API_HOST, axios }: PartialQueryConfigForApi,
 ) =>
@@ -79,6 +81,19 @@ export const getAccessibleItems = async (
       .then(({ data }) => data),
   );
 
+export const searchItems = async (
+  params: ItemSearchParams,
+  pagination: PaginationParams,
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  verifyAuthentication(() =>
+    axios
+      .get<
+        Paginated<DiscriminatedItem>
+      >(`${API_HOST}/${buildSearchItems(params, pagination)}`)
+      .then(({ data }) => data),
+  );
+
 export type PostItemPayloadType = Partial<DiscriminatedItem> &
   Pick<DiscriminatedItem, 'type' | 'name'> &
   Partial<{

src/api/routes.ts

@@ -38,7 +38,7 @@ export const SHORT_LINKS_ROUTE = `${ITEMS_ROUTE}/short-links`;
 export const SHORT_LINKS_LIST_ROUTE = `${SHORT_LINKS_ROUTE}/list`;
 export const EMBEDDED_LINKS_ROUTE = `${ITEMS_ROUTE}/embedded-links/metadata`;
 
-export type ItemSearchParams =
+export type AccessibleItemSearchParams =
   | {
       creatorId?: Member['id'];
       name?: string;
@@ -54,13 +54,30 @@ export type ItemSearchParams =
     }
   | undefined;
 
+export type ItemSearchParams =
+  | {
+      creatorId?: Member['id'];
+      keywords?: string[];
+      ordering?: 'desc' | 'asc';
+      sortBy?:
+        | 'rank'
+        | 'item.name'
+        | 'item.type'
+        | 'item.creator.name'
+        | 'item.created_at'
+        | 'item.updated_at';
+      permissions?: PermissionLevel[];
+      types?: UnionOfConst<typeof ItemType>[];
+    }
+  | undefined;
+
 export type ItemChildrenParams = {
   ordered?: boolean;
   types?: UnionOfConst<typeof ItemType>[];
 };
 
 export const buildGetAccessibleItems = (
-  params: ItemSearchParams,
+  params: AccessibleItemSearchParams,
   pagination: PaginationParams,
 ) =>
   `${ITEMS_ROUTE}/accessible${qs.stringify(
@@ -71,6 +88,18 @@ export const buildGetAccessibleItems = (
     },
   )}`;
 
+export const buildSearchItems = (
+  params: ItemSearchParams,
+  pagination: PaginationParams,
+) =>
+  `${ITEMS_ROUTE}/search${qs.stringify(
+    { ...params, ...pagination },
+    {
+      arrayFormat: 'repeat',
+      addQueryPrefix: true,
+    },
+  )}`;
+
 export const buildPostItemRoute = (parentId?: UUID) => {
   let url = ITEMS_ROUTE;
   if (parentId) {

src/config/keys.ts

@@ -140,7 +140,10 @@ export const itemKeys = {
   // shared items
   shared: () => [...itemKeys.all, 'shared'] as const,
 
-  search: (args: {
+  search: (args: ItemSearchParams) =>
+    [...itemKeys.all, 'search', args] as const,
+
+  publishedSearch: (args: {
     query?: string;
     categories?: Category['id'][][];
     isPublishedRoot?: boolean;
@@ -151,7 +154,11 @@ export const itemKeys = {
     highlightPostTag?: string;
     page?: number;
   }) =>
-    [...itemKeys.all, 'search', { isPublishedRoot: false, ...args }] as const,
+    [
+      ...itemKeys.all,
+      'publishedSearch',
+      { isPublishedRoot: false, ...args },
+    ] as const,
 
   published: () => {
     const publishedBaseKey = [...itemKeys.all, 'collections'] as const;

src/hooks/item.ts

@@ -13,7 +13,11 @@ import {
 
 import { splitRequestByIdsAndReturn } from '../api/axios.js';
 import * as Api from '../api/item.js';
-import { ItemChildrenParams, ItemSearchParams } from '../api/routes.js';
+import {
+  AccessibleItemSearchParams,
+  ItemChildrenParams,
+  ItemSearchParams,
+} from '../api/routes.js';
 import {
   CONSTANT_KEY_STALE_TIME_MILLISECONDS,
   DEFAULT_THUMBNAIL_SIZE,
@@ -51,7 +55,7 @@ const config = (
      * @returns
      */
     useAccessibleItems: (
-      params?: ItemSearchParams,
+      params?: AccessibleItemSearchParams,
       pagination?: PaginationParams,
     ) => {
       const queryClient = useQueryClient();
@@ -292,6 +296,24 @@ const config = (
       });
     },
 
+    useSearchItems: (
+      args: ItemSearchParams,
+      pagination: PaginationParams,
+      options: { enabled?: boolean } = { enabled: true },
+    ) =>
+      useInfiniteQuery({
+        queryKey: itemKeys.search(args),
+        queryFn: ({ pageParam }) =>
+          Api.searchItems(
+            args,
+            { page: pageParam ?? 1, ...pagination },
+            queryConfig,
+          ),
+        getNextPageParam: (_lastPage, pages) => pages.length + 1,
+        enabled: options.enabled,
+        refetchOnWindowFocus: () => false,
+      }),
+
     /**
      * @deprecated use url alternative when possible
      * @param id itemId to download content from

src/hooks/search.test.ts

@@ -106,7 +106,7 @@ describe('Published Search Hook', () => {
       const categories = [['mycategoryid']];
       const hook = () =>
         hooks.useSearchPublishedItems({ query, categories, page: 1 });
-      const key = itemKeys.search({
+      const key = itemKeys.publishedSearch({
         query,
         categories,
         page: 1,
@@ -127,7 +127,7 @@ describe('Published Search Hook', () => {
 
     it(`does not fetch if no query nor categories is provided`, async () => {
       const hook = () => hooks.useSearchPublishedItems({});
-      const key = itemKeys.search({ page: 1 });
+      const key = itemKeys.publishedSearch({ page: 1 });
       const endpoints = [{ route, response: RESPONSE }];
       const { data, isFetched } = await mockHook({
         endpoints,
@@ -148,7 +148,7 @@ describe('Published Search Hook', () => {
       const isPublishedRoot = true;
 
       const spy = vi.spyOn(axios, 'post');
-      const key = itemKeys.search({
+      const key = itemKeys.publishedSearch({
         isPublishedRoot,
         query,
         categories,
@@ -199,7 +199,7 @@ describe('Published Search Hook', () => {
       const isPublishedRoot = true;
       const page = 3;
       const spy = vi.spyOn(axios, 'post');
-      const key = itemKeys.search({
+      const key = itemKeys.publishedSearch({
         isPublishedRoot,
         query,
         categories,
@@ -248,7 +248,7 @@ describe('Published Search Hook', () => {
       const query = 'some string';
       const categories = [['mycategoryid']];
       const isPublishedRoot = true;
-      const key = itemKeys.search({
+      const key = itemKeys.publishedSearch({
         isPublishedRoot,
         query,
         categories,

src/hooks/search.ts

@@ -34,7 +34,7 @@ export default (queryConfig: QueryClientConfig) => {
     } & Api.MeiliSearchProps) => {
       const debouncedQuery = useDebounce(query, 500);
       return useQuery({
-        queryKey: itemKeys.search({
+        queryKey: itemKeys.publishedSearch({
           query: debouncedQuery,
           categories,
           isPublishedRoot,