[Firecms] Add support for typesense search

lib/.gitignore

@@ -17,6 +17,7 @@ dist
 .env.test.local
 .env.production.local
 
+yarn.lock
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

lib/package.json

@@ -75,7 +75,8 @@
         "react": "^18.0.0",
         "react-dom": "^18.0.0",
         "react-router": "^6.2.0",
-        "react-router-dom": "^6.2.0"
+        "react-router-dom": "^6.2.0",
+        "typesense": "1.5.3"
     },
     "eslintConfig": {
         "extends": [
@@ -120,6 +121,7 @@
         "react-router-dom": "^6.9.0",
         "tsd": "^0.28.1",
         "typescript": "^5.0.2",
+        "typesense": "1.5.3",
         "vite": "^4.2.1"
     },
     "files": [

lib/src/firebase_app/index.ts

@@ -16,4 +16,4 @@ export { useInitializeAppCheck } from "./hooks/useInitializeAppCheck";
 export * from "./types/auth";
 
 export type { FirestoreTextSearchController } from "./types/text_search";
-export { performAlgoliaTextSearch } from "./types/text_search";
+export { performAlgoliaTextSearch, performTypesenseSearch } from "./types/text_search";

lib/src/firebase_app/types/text_search.ts

@@ -1,4 +1,6 @@
 import { SearchIndex } from "algoliasearch";
+import Collection from "typesense/lib/Typesense/Collection";
+import { SearchParams } from "typesense/lib/Typesense/Documents";
 
 /**
  * Use this controller to return a list of ids from a search index, given a
@@ -10,7 +12,10 @@ import { SearchIndex } from "algoliasearch";
  * @see performAlgoliaTextSearch
  * @category Firebase
  */
-export type FirestoreTextSearchController = (props: { path: string, searchString: string }) => Promise<readonly string[]> | undefined;
+export type FirestoreTextSearchController = (props: {
+    path: string;
+    searchString: string;
+}) => Promise<readonly string[]> | undefined;
 
 /**
  * Utility function to perform a text search in an algolia index,
@@ -19,8 +24,10 @@ export type FirestoreTextSearchController = (props: { path: string, searchString
  * @param query
  * @category Firebase
  */
-export function performAlgoliaTextSearch(index: SearchIndex, query: string): Promise<readonly string[]> {
-
+export function performAlgoliaTextSearch(
+    index: SearchIndex,
+    query: string
+): Promise<readonly string[]> {
     console.debug("Performing Algolia query", index, query);
     return index
         .search(query)
@@ -32,3 +39,27 @@ export function performAlgoliaTextSearch(index: SearchIndex, query: string): Pro
             return [];
         });
 }
+
+/**
+ * Utility function to perform a text search in an typesense index,
+ * returning the ids of the entities.
+ * @param index
+ * @param query
+ * @category Firebase
+ */
+export function performTypesenseSearch(
+    index: Collection<{}>,
+    searchParameters: SearchParams
+): Promise<readonly string[]> {
+    return index
+        .documents()
+        .search(searchParameters)
+        .then(({ hits }) => {
+            if (hits === undefined) return [];
+            return hits.map((hit: any) => hit.document.id as string);
+        })
+        .catch((err: any) => {
+            console.log(err);
+            return [];
+        });
+}