Add support for search indexes

Author: sistrall

docs/site-search.md

@@ -36,7 +36,7 @@ const client = buildClient({ apiToken: 'YOUR_API_TOKEN' });
 
 const { state, error, data } = useSiteSearch({
   client,
-  buildTriggerId: '7497',
+  searchIndexId: '7497',
   // optional: by default fuzzy-search is not active
   fuzzySearch: true,
   // optional: you can omit it you only have one locale, or you want to find results in every locale
@@ -60,7 +60,7 @@ For a complete walk-through, please refer to the [DatoCMS Site Search documentat
 | prop                | type                                                               | required           | description                                                                                                                                | default                                                    |
 | ------------------- | ------------------------------------------------------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
 | client              | CMA Client instance                                                | :white_check_mark: | [DatoCMS CMA Client](https://www.datocms.com/docs/content-management-api/using-the-nodejs-clients) instance                                |                                                            |
-| buildTriggerId      | string                                                             | :white_check_mark: | The [ID of the build trigger](https://www.datocms.com/docs/site-search/base-integration#performing-searches) to use to find search results |                                                            |
+| searchIndexId      | string                                                             | :white_check_mark: | The [ID of the the search index](https://www.datocms.com/docs/site-search/base-integration#performing-searches) to use to find search results |                                                            |
 | fuzzySearch         | boolean                                                            | :x:                | Whether fuzzy-search is active or not. When active, it will also find strings that approximately match the query provided.                 | false                                                      |
 | resultsPerPage      | number                                                             | :x:                | The number of search results to show per page                                                                                              | 8                                                          |
 | highlightMatch      | (match, key, context: 'title' \| 'bodyExcerpt') => React.ReactNode | :x:                | A function specifying how to highlight the part of page title/content that matches the query                                               | (text, key) => (<mark key={key}>{text}</mark>) |
@@ -127,7 +127,7 @@ function App() {
       ) : (
         <mark key={key}>{text}</mark>
       ),
-    buildTriggerId: '7497',
+    searchIndexId: '7497',
     resultsPerPage: 10,
   });
 

examples/src/SiteSearchExamples/index.jsx

@@ -12,7 +12,7 @@ export default function SiteSearchExamples() {
   const [query, setQuery] = useState('');
   const { state, error, data } = useSiteSearch({
     client,
-    buildTriggerId: '7497',
+    searchIndexId: '7497',
     // optional: you can omit it you only have one locale, or you want to find results in every locale
     initialState: { locale: 'en' },
     // optional: by default fuzzy-search is not active

src/useSiteSearch/index.tsx

@@ -15,6 +15,7 @@ type SearchResultInstancesHrefSchema = {
     fuzzy?: boolean;
     query: string;
     build_trigger_id?: string;
+    search_index_id?: string;
     locale?: string;
     [k: string]: unknown;
   };
@@ -63,6 +64,7 @@ type Highlighter = (
 export type UseSiteSearchConfig<Client extends GenericClient> = {
   client: Client;
   buildTriggerId: string;
+  searchIndexId: string;
   fuzzySearch?: boolean;
   resultsPerPage?: number;
   highlightMatch?: Highlighter;
@@ -161,6 +163,7 @@ export function useSiteSearch<Client extends GenericClient>(
             query: state.query,
             locale: state.locale,
             build_trigger_id: config.buildTriggerId,
+            search_index_id: config.searchIndexId,
             ...(config.fuzzySearch === true ? { fuzzy: true } : {}),
           },
           page: {
@@ -196,6 +199,7 @@ export function useSiteSearch<Client extends GenericClient>(
     resultsPerPage,
     state,
     config.buildTriggerId,
+    config.searchIndexId,
     config.fuzzySearch,
     config.client.config.apiToken,
   ]);