refactor(search): adopt Typesense client types across the UI

Author: tharropoulos

packages/docsearch-react/src/DocSearch.tsx

@@ -229,8 +229,8 @@ export interface DocSearchProps {
    * Hook to wrap or modify the algolia search client.
    */
   transformSearchClient?: (
-    searchClient: DocSearchTransformClient
-  ) => DocSearchTransformClient;
+    searchClient: TypesenseDocsearchTransformClient
+  ) => TypesenseDocsearchTransformClient;
   /**
    * Disable storage and usage of recent and favorite searches.
    */

packages/docsearch-react/src/ScreenState.tsx

@@ -41,7 +41,7 @@ export interface ScreenStateProps<TItem extends BaseItem>
   canHandleAskAi: boolean;
   inputRef: React.MutableRefObject<HTMLInputElement | null>;
   hitComponent: DocSearchProps['hitComponent'];
-  indexName: DocSearchProps['indexName'];
+  indexName: DocSearchProps['typesenseCollectionName'];
   messages: UseChatHelpers<AIMessage>['messages'];
   status: UseChatHelpers<AIMessage>['status'];
   askAiError?: Error;

packages/docsearch-react/src/useSearchClient.ts

@@ -2,7 +2,10 @@ import type { SearchResponses } from 'algoliasearch/lite';
 import React from 'react';
 import { SearchClient as TypesenseSearchClient } from 'typesense';
 import type { ConfigurationOptions as TypesenseConfigurationOptions } from 'typesense/lib/Typesense/Configuration';
-import type { SearchResponse as TypesenseSearchResponse, DocumentSchema } from 'typesense/lib/Typesense/Documents';
+import type {
+  SearchResponse as TypesenseSearchResponse,
+  DocumentSchema,
+} from 'typesense/lib/Typesense/Documents';
 import type { MultiSearchRequestSchema } from 'typesense/lib/Typesense/Types';
 import { SearchResponseAdapter as TypesenseSearchResponseAdapter } from 'typesense-instantsearch-adapter/lib/SearchResponseAdapter';
 
@@ -40,8 +43,10 @@ type AdaptedHit<T extends DocumentSchema> = T & {
 };
 
 export function useSearchClient(
-  transformSearchClient: (searchClient: TypesenseDocsearchTransformClient) => TypesenseDocsearchTransformClient,
-  typesenseServerConfig: TypesenseConfigurationOptions,
+  transformSearchClient: (
+    searchClient: TypesenseDocsearchTransformClient
+  ) => TypesenseDocsearchTransformClient,
+  typesenseServerConfig: TypesenseConfigurationOptions
 ): TypesenseDocsearchTransformClient {
   const searchClient = React.useMemo(() => {
     const typesense = new TypesenseSearchClient(typesenseServerConfig);
@@ -60,21 +65,23 @@ export function useSearchClient(
         const response = await typesense.multiSearch.perform<[T]>({
           searches: [request],
         });
-        const typesenseSearchResponseAdapter = new TypesenseSearchResponseAdapter(
-          response.results[0],
-          {
-            params: {
-              ...request,
-              highlightPreTag: '<mark>',
-              highlightPostTag: '</mark>',
+        const typesenseSearchResponseAdapter =
+          new TypesenseSearchResponseAdapter(
+            response.results[0],
+            {
+              params: {
+                ...request,
+                highlightPreTag: '<mark>',
+                highlightPostTag: '</mark>',
+              },
             },
-          },
-          {
-            geoLocationField: '',
-          },
-        );
+            {
+              geoLocationField: '',
+            }
+          );
 
-        const adapted: AdaptedSearchResponse<T> = typesenseSearchResponseAdapter.adapt();
+        const adapted: AdaptedSearchResponse<T> =
+          typesenseSearchResponseAdapter.adapt();
 
         return {
           results: [

packages/docsearch-react/src/useSuggestedQuestions.ts

@@ -3,11 +3,11 @@ import { useEffect, useState } from 'react';
 
 import { SUGGESTED_QUETIONS_INDEX_NAME } from './constants';
 
-import type { DocSearchTransformClient, SuggestedQuestion, SuggestedQuestionHit } from '.';
+import type { SuggestedQuestion, SuggestedQuestionHit, TypesenseDocsearchTransformClient } from '.';
 
 type UseSuggestedQuestionsProps = {
   assistantId: string | null;
-  searchClient: DocSearchTransformClient;
+  searchClient: TypesenseDocsearchTransformClient;
   suggestedQuestionsEnabled?: boolean;
 };
 
@@ -19,13 +19,15 @@ export const useSuggestedQuestions = ({
   const [suggestedQuestions, setSuggestedQuestions] = useState<SuggestedQuestionHit[]>([]);
 
   useEffect(() => {
+    // eslint-disable-next-line no-warning-comments
+    // TODO: add typesense search parameters
     const getSuggestedQuestions = async (): Promise<void> => {
       const { results } = await searchClient.search<SuggestedQuestion>({
         requests: [
           {
-            indexName: SUGGESTED_QUETIONS_INDEX_NAME,
-            filters: `state:published AND assistantId:${assistantId}`,
-            hitsPerPage: 3,
+            collection: SUGGESTED_QUETIONS_INDEX_NAME,
+            filter_by: `state:published && assistantId:${assistantId}`,
+            per_page: 3,
           },
         ],
       });