Add ability to turn off group flattening.

#178
typesense · Jul 26, 2023 · 04bcb34 · 04bcb34
1 parent 07e82aa
commit 04bcb34
Show file tree

Hide file tree

Showing 13 changed files with 940 additions and 13 deletions.
diff --git a/dist/typesense-instantsearch-adapter.js b/dist/typesense-instantsearch-adapter.js
diff --git a/dist/typesense-instantsearch-adapter.js.map b/dist/typesense-instantsearch-adapter.js.map
diff --git a/dist/typesense-instantsearch-adapter.min.js b/dist/typesense-instantsearch-adapter.min.js
diff --git a/dist/typesense-instantsearch-adapter.min.js.map b/dist/typesense-instantsearch-adapter.min.js.map
diff --git a/index.d.ts b/index.d.ts
@@ -88,6 +88,7 @@ interface BaseAdapterOptions {
   geoLocationField?: string;
   facetableFieldsWithSpecialCharacters?: string[];
   renderingContent?: object;
+  flattenGroupedHits?: boolean;
 }
 
 interface CollectionSearchParameters {

diff --git a/lib/Configuration.js b/lib/Configuration.js
diff --git a/lib/Configuration.js.map b/lib/Configuration.js.map
diff --git a/lib/SearchResponseAdapter.js b/lib/SearchResponseAdapter.js
diff --git a/lib/SearchResponseAdapter.js.map b/lib/SearchResponseAdapter.js.map
diff --git a/src/Configuration.js b/src/Configuration.js
@@ -52,6 +52,7 @@ export class Configuration {
     });
 
     this.renderingContent = options.renderingContent;
+    this.flattenGroupedHits = options.flattenGroupedHits ?? true;
   }
 
   validate() {

diff --git a/src/SearchResponseAdapter.js b/src/SearchResponseAdapter.js
@@ -26,8 +26,20 @@ export class SearchResponseAdapter {
 
     // adaptedResult is now in the form of [[{}, {}], [{}, {}], ...]
     //  where each element in the outermost array corresponds to a group.
-    // We now flatten it to [{}, {}, {}]
-    adaptedResult = adaptedResult.flat();
+
+    if (this.configuration.flattenGroupedHits) {
+      // We flatten it to [{}, {}, {}]
+      adaptedResult = adaptedResult.flat();
+    } else {
+      // We flatten it to [{ ..., grouped_hits: [{}, {}] }, {}, {}]
+      // We set the first element in the group as the hit, and then add a new key called grouped_hits with the other hits
+      adaptedResult = adaptedResult.map((adaptedGroupedHit) => {
+        return {
+          ...adaptedGroupedHit[0],
+          _grouped_hits: adaptedGroupedHit,
+        };
+      });
+    }
 
     return adaptedResult;
   }