@docsearch/react 3.3.5 → 3.5.0

package/dist/esm/DocSearch.d.ts

@@ -14,6 +14,7 @@ export interface DocSearchProps {
     indexName: string;
     placeholder?: string;
     searchParameters?: SearchOptions;
+    maxResultsPerGroup?: number;
     transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
     hitComponent?: (props: {
         hit: InternalDocSearchHit | StoredDocSearchHit;
@@ -30,5 +31,6 @@ export interface DocSearchProps {
     getMissingResultsUrl?: ({ query }: {
         query: string;
     }) => string;
+    insights?: AutocompleteOptions<InternalDocSearchHit>['insights'];
 }
 export declare function DocSearch(props: DocSearchProps): JSX.Element;

package/dist/esm/DocSearchModal.d.ts

@@ -11,4 +11,4 @@ export declare type DocSearchModalProps = DocSearchProps & {
     onClose?: () => void;
     translations?: ModalTranslations;
 };
-export declare function DocSearchModal({ appId, apiKey, indexName, placeholder, searchParameters, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, }: DocSearchModalProps): JSX.Element;
+export declare function DocSearchModal({ appId, apiKey, indexName, placeholder, searchParameters, maxResultsPerGroup, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, }: DocSearchModalProps): JSX.Element;

package/dist/esm/DocSearchModal.js

@@ -43,6 +43,7 @@ export function DocSearchModal(_ref) {
       _ref$placeholder = _ref.placeholder,
       placeholder = _ref$placeholder === void 0 ? 'Search docs' : _ref$placeholder,
       searchParameters = _ref.searchParameters,
+      maxResultsPerGroup = _ref.maxResultsPerGroup,
       _ref$onClose = _ref.onClose,
       onClose = _ref$onClose === void 0 ? noop : _ref$onClose,
       _ref$transformItems = _ref.transformItems,
@@ -64,7 +65,9 @@ export function DocSearchModal(_ref) {
       initialQueryFromProp = _ref$initialQuery === void 0 ? '' : _ref$initialQuery,
       _ref$translations = _ref.translations,
       translations = _ref$translations === void 0 ? {} : _ref$translations,
-      getMissingResultsUrl = _ref.getMissingResultsUrl;
+      getMissingResultsUrl = _ref.getMissingResultsUrl,
+      _ref$insights = _ref.insights,
+      insights = _ref$insights === void 0 ? false : _ref$insights;
 
   var footerTranslations = translations.footer,
       searchBoxTranslations = translations.searchBox,
@@ -128,6 +131,7 @@ export function DocSearchModal(_ref) {
           searchSuggestions: []
         }
       },
+      insights: insights,
       navigator: navigator,
       onStateChange: function onStateChange(props) {
         setState(props.state);
@@ -182,6 +186,7 @@ export function DocSearchModal(_ref) {
           }];
         }
 
+        var insightsActive = Boolean(insights);
         return searchClient.search([{
           query: query,
           indexName: indexName,
@@ -191,7 +196,8 @@ export function DocSearchModal(_ref) {
             snippetEllipsisText: '…',
             highlightPreTag: '<mark>',
             highlightPostTag: '</mark>',
-            hitsPerPage: 20
+            hitsPerPage: 20,
+            clickAnalytics: insightsActive
           }, searchParameters)
         }]).catch(function (error) {
           // The Algolia `RetryError` happens when all the servers have
@@ -210,7 +216,7 @@ export function DocSearchModal(_ref) {
               nbHits = _results$.nbHits;
           var sources = groupBy(hits, function (hit) {
             return removeHighlightTags(hit);
-          }); // We store the `lvl0`s to display them as search suggestions
+          }, maxResultsPerGroup); // We store the `lvl0`s to display them as search suggestions
           // in the "no results" screen.
 
           if (sourcesState.context.searchSuggestions.length < Object.keys(sources).length) {
@@ -222,6 +228,19 @@ export function DocSearchModal(_ref) {
           setContext({
             nbHits: nbHits
           });
+          var insightsParams = {};
+
+          if (insightsActive) {
+            insightsParams = {
+              __autocomplete_indexName: indexName,
+              __autocomplete_queryID: results[0].queryID,
+              __autocomplete_algoliaCredentials: {
+                appId: appId,
+                apiKey: apiKey
+              }
+            };
+          }
+
           return Object.values(sources).map(function (items, index) {
             return {
               sourceId: "hits".concat(index),
@@ -241,13 +260,20 @@ export function DocSearchModal(_ref) {
               getItems: function getItems() {
                 return Object.values(groupBy(items, function (item) {
                   return item.hierarchy.lvl1;
-                })).map(transformItems).map(function (groupedHits) {
+                }, maxResultsPerGroup)).map(transformItems).map(function (groupedHits) {
                   return groupedHits.map(function (item) {
-                    return _objectSpread(_objectSpread({}, item), {}, {
-                      __docsearch_parent: item.type !== 'lvl1' && groupedHits.find(function (siblingItem) {
-                        return siblingItem.type === 'lvl1' && siblingItem.hierarchy.lvl1 === item.hierarchy.lvl1;
-                      })
+                    var parent = null;
+                    var potentialParent = groupedHits.find(function (siblingItem) {
+                      return siblingItem.type === 'lvl1' && siblingItem.hierarchy.lvl1 === item.hierarchy.lvl1;
                     });
+
+                    if (item.type !== 'lvl1' && potentialParent) {
+                      parent = potentialParent;
+                    }
+
+                    return _objectSpread(_objectSpread({}, item), {}, {
+                      __docsearch_parent: parent
+                    }, insightsParams);
                   });
                 }).flat();
               }
@@ -256,7 +282,7 @@ export function DocSearchModal(_ref) {
         });
       }
     });
-  }, [indexName, searchParameters, searchClient, onClose, recentSearches, favoriteSearches, saveRecentSearch, initialQuery, placeholder, navigator, transformItems, disableUserPersonalization]);
+  }, [indexName, searchParameters, maxResultsPerGroup, searchClient, onClose, recentSearches, favoriteSearches, saveRecentSearch, initialQuery, placeholder, navigator, transformItems, disableUserPersonalization, insights, appId, apiKey]);
   var getEnvironmentProps = autocomplete.getEnvironmentProps,
       getRootProps = autocomplete.getRootProps,
       refresh = autocomplete.refresh;

package/dist/esm/types/DocSearchHit.d.ts

@@ -64,5 +64,11 @@ export declare type DocSearchHit = {
         };
     };
     _distinctSeqID?: number;
+    __autocomplete_indexName?: string;
+    __autocomplete_queryID?: string;
+    __autocomplete_algoliaCredentials?: {
+        appId: string;
+        apiKey: string;
+    };
 };
 export {};

package/dist/esm/utils/groupBy.d.ts

@@ -1 +1 @@
-export declare function groupBy<TValue extends Record<string, unknown>>(values: TValue[], predicate: (value: TValue) => string): Record<string, TValue[]>;
+export declare function groupBy<TValue extends Record<string, unknown>>(values: TValue[], predicate: (value: TValue) => string, maxResultsPerGroup?: number): Record<string, TValue[]>;

package/dist/esm/utils/groupBy.js

@@ -1,4 +1,4 @@
-export function groupBy(values, predicate) {
+export function groupBy(values, predicate, maxResultsPerGroup) {
   return values.reduce(function (acc, item) {
     var key = predicate(item);
 
@@ -8,7 +8,7 @@ export function groupBy(values, predicate) {
     // This acts as a frontend alternative to `distinct`.
 
 
-    if (acc[key].length < 5) {
+    if (acc[key].length < (maxResultsPerGroup || 5)) {
       acc[key].push(item);
     }
 

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.3.5";
+export declare const version = "3.5.0";

package/dist/esm/version.js

@@ -1 +1 @@
-export var version = '3.3.5';
+export var version = '3.5.0';