@docsearch/react 3.4.0 → 3.5.1

package/dist/esm/DocSearch.d.ts

@@ -31,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, maxResultsPerGroup, 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

@@ -65,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,
@@ -117,6 +119,18 @@ export function DocSearchModal(_ref) {
       recentSearches.add(search);
     }
   }, [favoriteSearches, recentSearches, disableUserPersonalization]);
+  var sendItemClickEvent = React.useCallback(function (item) {
+    if (!state.context.algoliaInsightsPlugin || !item.__autocomplete_id) return;
+    var insightsItem = item;
+    var insightsClickParams = {
+      eventName: 'Item Selected',
+      index: insightsItem.__autocomplete_indexName,
+      items: [insightsItem],
+      positions: [item.__autocomplete_id],
+      queryID: insightsItem.__autocomplete_queryID
+    };
+    state.context.algoliaInsightsPlugin.insights.clickedObjectIDsAfterSearch(insightsClickParams);
+  }, [state.context.algoliaInsightsPlugin]);
   var autocomplete = React.useMemo(function () {
     return createAutocomplete({
       id: 'docsearch',
@@ -129,6 +143,7 @@ export function DocSearchModal(_ref) {
           searchSuggestions: []
         }
       },
+      insights: insights,
       navigator: navigator,
       onStateChange: function onStateChange(props) {
         setState(props.state);
@@ -183,6 +198,7 @@ export function DocSearchModal(_ref) {
           }];
         }
 
+        var insightsActive = Boolean(insights);
         return searchClient.search([{
           query: query,
           indexName: indexName,
@@ -192,7 +208,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
@@ -223,6 +240,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),
@@ -244,11 +274,18 @@ export function DocSearchModal(_ref) {
                   return item.hierarchy.lvl1;
                 }, 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();
               }
@@ -257,7 +294,7 @@ export function DocSearchModal(_ref) {
         });
       }
     });
-  }, [indexName, searchParameters, maxResultsPerGroup, 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;
@@ -365,6 +402,8 @@ export function DocSearchModal(_ref) {
     translations: screenStateTranslations,
     getMissingResultsUrl: getMissingResultsUrl,
     onItemClick: function onItemClick(item, event) {
+      // If insights is active, send insights click event
+      sendItemClickEvent(item);
       saveRecentSearch(item);
 
       if (!isModifierEvent(event)) {

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

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

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

@@ -0,0 +1,10 @@
+import type { AutocompleteContext, AutocompleteInsightsApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
+interface DocSearchContext extends AutocompleteContext {
+    algoliaInsightsPlugin?: {
+        insights: AutocompleteInsightsApi;
+    };
+}
+export interface DocSearchState<TItem extends BaseItem> extends AutocompleteState<TItem> {
+    context: DocSearchContext;
+}
+export {};

package/dist/esm/types/DocSearchState.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,4 @@
 export * from './DocSearchHit';
+export * from './DocSearchState';
 export * from './InternalDocSearchHit';
 export * from './StoredDocSearchHit';

package/dist/esm/types/index.js

@@ -1,3 +1,4 @@
 export * from './DocSearchHit';
+export * from './DocSearchState';
 export * from './InternalDocSearchHit';
 export * from './StoredDocSearchHit';

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.4.0";
+export declare const version = "3.5.1";

package/dist/esm/version.js

@@ -1 +1 @@
-export var version = '3.4.0';
+export var version = '3.5.1';