import { useCallback } from 'react'; import { useInstantSearchContext } from '../lib/useInstantSearchContext'; import { useIsomorphicLayoutEffect } from '../lib/useIsomorphicLayoutEffect'; import { useSearchResults } from '../lib/useSearchResults'; import { useSearchState } from '../lib/useSearchState'; import type { SearchResultsApi } from '../lib/useSearchResults'; import type { SearchStateApi } from '../lib/useSearchState'; import type { InstantSearch, Middleware, UiState } from 'instantsearch.js'; type InstantSearchApi = SearchStateApi & SearchResultsApi & { use: (...middlewares: Middleware[]) => () => void; refresh: InstantSearch['refresh']; status: InstantSearch['status']; error: InstantSearch['error']; }; export type UseInstantSearchProps = { /** * catch any error happening in the search lifecycle and handle it with this hook. */ catchError?: boolean; }; export function useInstantSearch({ catchError, }: UseInstantSearchProps = {}): InstantSearchApi { const search = useInstantSearchContext(); const { uiState, setUiState, indexUiState, setIndexUiState } = useSearchState(); const { results, scopedResults } = useSearchResults(); const use: InstantSearchApi['use'] = useCallback( (...middlewares: Middleware[]) => { search.use(...middlewares); return () => { search.unuse(...middlewares); }; }, [search] ); const refresh: InstantSearchApi['refresh'] = useCallback(() => { search.refresh(); }, [search]); useIsomorphicLayoutEffect(() => { if (catchError) { const onError = () => {}; search.addListener('error', onError); return () => search.removeListener('error', onError); } return () => {}; }, [search, catchError]); return { results, scopedResults, uiState, setUiState, indexUiState, setIndexUiState, use, refresh, status: search.status, error: search.error, }; }