@algolia/autocomplete-core 1.11.1 → 1.12.1

package/dist/esm/createAutocomplete.js

@@ -28,6 +28,7 @@ export function createAutocomplete(options) {
     navigator: props.navigator
   }, setters));
   function onStoreStateChange(_ref) {
+    var _state$context, _state$context$algoli;
     var prevState = _ref.prevState,
       state = _ref.state;
     props.onStateChange(_objectSpread({
@@ -36,6 +37,13 @@ export function createAutocomplete(options) {
       refresh: refresh,
       navigator: props.navigator
     }, setters));
+    if (!isAlgoliaInsightsPluginEnabled() && (_state$context = state.context) !== null && _state$context !== void 0 && (_state$context$algoli = _state$context.algoliaInsightsPlugin) !== null && _state$context$algoli !== void 0 && _state$context$algoli.__automaticInsights && props.insights !== false) {
+      var plugin = createAlgoliaInsightsPlugin({
+        __autocomplete_clickAnalytics: false
+      });
+      props.plugins.push(plugin);
+      subscribePlugins([plugin]);
+    }
   }
   function refresh() {
     return onInput(_objectSpread({
@@ -50,34 +58,40 @@ export function createAutocomplete(options) {
       store: store
     }, setters));
   }
-  if (options.insights && !props.plugins.some(function (plugin) {
-    return plugin.name === 'aa.algoliaInsightsPlugin';
-  })) {
-    var insightsParams = typeof options.insights === 'boolean' ? {} : options.insights;
+  function subscribePlugins(plugins) {
+    plugins.forEach(function (plugin) {
+      var _plugin$subscribe;
+      return (_plugin$subscribe = plugin.subscribe) === null || _plugin$subscribe === void 0 ? void 0 : _plugin$subscribe.call(plugin, _objectSpread(_objectSpread({}, setters), {}, {
+        navigator: props.navigator,
+        refresh: refresh,
+        onSelect: function onSelect(fn) {
+          subscribers.push({
+            onSelect: fn
+          });
+        },
+        onActive: function onActive(fn) {
+          subscribers.push({
+            onActive: fn
+          });
+        },
+        onResolve: function onResolve(fn) {
+          subscribers.push({
+            onResolve: fn
+          });
+        }
+      }));
+    });
+  }
+  function isAlgoliaInsightsPluginEnabled() {
+    return props.plugins.some(function (plugin) {
+      return plugin.name === 'aa.algoliaInsightsPlugin';
+    });
+  }
+  if (props.insights && !isAlgoliaInsightsPluginEnabled()) {
+    var insightsParams = typeof props.insights === 'boolean' ? {} : props.insights;
     props.plugins.push(createAlgoliaInsightsPlugin(insightsParams));
   }
-  props.plugins.forEach(function (plugin) {
-    var _plugin$subscribe;
-    return (_plugin$subscribe = plugin.subscribe) === null || _plugin$subscribe === void 0 ? void 0 : _plugin$subscribe.call(plugin, _objectSpread(_objectSpread({}, setters), {}, {
-      navigator: props.navigator,
-      refresh: refresh,
-      onSelect: function onSelect(fn) {
-        subscribers.push({
-          onSelect: fn
-        });
-      },
-      onActive: function onActive(fn) {
-        subscribers.push({
-          onActive: fn
-        });
-      },
-      onResolve: function onResolve(fn) {
-        subscribers.push({
-          onResolve: fn
-        });
-      }
-    }));
-  });
+  subscribePlugins(props.plugins);
   injectMetadata({
     metadata: getMetadata({
       plugins: props.plugins,

package/dist/esm/getDefaultProps.js

@@ -26,7 +26,7 @@ export function getDefaultProps(props, pluginSubscribers) {
     autoFocus: false,
     defaultActiveItemId: null,
     stallThreshold: 300,
-    insights: false,
+    insights: undefined,
     environment: environment,
     shouldPanelOpen: function shouldPanelOpen(_ref) {
       var state = _ref.state;

package/dist/esm/onInput.js

@@ -28,7 +28,8 @@ export function onInput(_ref) {
     setIsOpen = setters.setIsOpen,
     setQuery = setters.setQuery,
     setActiveItemId = setters.setActiveItemId,
-    setStatus = setters.setStatus;
+    setStatus = setters.setStatus,
+    setContext = setters.setContext;
   setQuery(query);
   setActiveItemId(props.defaultActiveItemId);
   if (!query && props.openOnFocus === false) {
@@ -78,6 +79,20 @@ export function onInput(_ref) {
         return preResolve(itemsOrDescription, source.sourceId, store.getState());
       });
     })).then(resolve).then(function (responses) {
+      var __automaticInsights = responses.some(function (_ref2) {
+        var items = _ref2.items;
+        return isSearchResponseWithAutomaticInsightsFlag(items);
+      });
+
+      // No need to pollute the context if `__automaticInsights=false`
+      if (__automaticInsights) {
+        var _store$getState$conte;
+        setContext({
+          algoliaInsightsPlugin: _objectSpread(_objectSpread({}, ((_store$getState$conte = store.getState().context) === null || _store$getState$conte === void 0 ? void 0 : _store$getState$conte.algoliaInsightsPlugin) || {}), {}, {
+            __automaticInsights: __automaticInsights
+          })
+        });
+      }
       return postResolve(responses, sources, store);
     }).then(function (collections) {
       return reshape({
@@ -122,4 +137,7 @@ export function onInput(_ref) {
     }
   });
   return store.pendingRequests.add(request);
+}
+function isSearchResponseWithAutomaticInsightsFlag(items) {
+  return !Array.isArray(items) && Boolean(items === null || items === void 0 ? void 0 : items._automaticInsights);
 }

package/dist/esm/onKeyDown.js

@@ -88,7 +88,7 @@ export function onKeyDown(_ref) {
   } else if (event.key === 'Tab') {
     store.dispatch('blur', null);
 
-    // Hitting the `Escape` key signals the end of a user interaction with the
+    // Hitting the `Tab` key signals the end of a user interaction with the
     // autocomplete. At this point, we should ignore any requests that are still
     // pending and could reopen the panel once they resolve, because that would
     // result in an unsolicited UI behavior.

package/dist/esm/resolve.d.ts

@@ -1,5 +1,6 @@
 import type { ExecuteResponse, RequesterDescription, TransformResponse } from '@algolia/autocomplete-preset-algolia';
-import { MultipleQueriesQuery, SearchForFacetValuesResponse, SearchResponse } from '@algolia/client-search';
+import type { SearchResponse } from '@algolia/autocomplete-shared';
+import { MultipleQueriesQuery, SearchForFacetValuesResponse } from '@algolia/client-search';
 import { AutocompleteState, AutocompleteStore, BaseItem, InternalAutocompleteSource } from './types';
 declare type RequestDescriptionPreResolved<TItem extends BaseItem> = Pick<RequesterDescription<TItem>, 'execute' | 'requesterId' | 'searchClient' | 'transformResponse'> & {
     requests: Array<{

package/dist/esm/stateReducer.js

@@ -103,6 +103,7 @@ export var stateReducer = function stateReducer(state, action) {
           // we lose track of the highlighted index. (Query-suggestions use-case)
           action.props.openOnFocus === true ? action.props.defaultActiveItemId : null,
           status: 'idle',
+          completion: null,
           query: ''
         });
       }

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

@@ -2,17 +2,21 @@ export * from '@algolia/autocomplete-shared/dist/esm/core';
 export * from './AutocompleteStore';
 export * from './AutocompleteSubscribers';
 import { CreateAlgoliaInsightsPluginParams, AutocompleteInsightsApi as _AutocompleteInsightsApi, AlgoliaInsightsHit as _AlgoliaInsightsHit } from '@algolia/autocomplete-plugin-algolia-insights';
-import { AutocompleteOptions as _AutocompleteOptions, BaseItem } from '@algolia/autocomplete-shared/dist/esm/core';
+import { AutocompleteOptions as _AutocompleteOptions, InternalAutocompleteOptions as _InternalAutocompleteOptions, BaseItem } from '@algolia/autocomplete-shared/dist/esm/core';
 export declare type AutocompleteInsightsApi = _AutocompleteInsightsApi;
 export declare type AlgoliaInsightsHit = _AlgoliaInsightsHit;
-export interface AutocompleteOptions<TItem extends BaseItem> extends _AutocompleteOptions<TItem> {
+declare type InsightsOption = {
     /**
      * Whether to enable the Insights plugin and load the Insights library if it has not been loaded yet.
      *
      * See [**autocomplete-plugin-algolia-insights**](https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-plugin-algolia-insights/) for more information.
      *
-     * @default false
+     * @default undefined
      * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-insights
      */
-    insights?: CreateAlgoliaInsightsPluginParams | boolean;
+    insights?: CreateAlgoliaInsightsPluginParams | boolean | undefined;
+};
+export interface AutocompleteOptions<TItem extends BaseItem> extends _AutocompleteOptions<TItem>, InsightsOption {
+}
+export interface InternalAutocompleteOptions<TItem extends BaseItem> extends _InternalAutocompleteOptions<TItem>, InsightsOption {
 }

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

@@ -1,4 +1,5 @@
-import type { SearchForFacetValuesResponse, SearchResponse } from '@algolia/client-search';
+import type { SearchResponse } from '@algolia/autocomplete-shared';
+import type { SearchForFacetValuesResponse } from '@algolia/client-search';
 export declare function mapToAlgoliaResponse<THit>(rawResults: Array<SearchResponse<THit> | SearchForFacetValuesResponse>): {
     results: (SearchResponse<THit> | SearchForFacetValuesResponse)[];
     hits: import("@algolia/client-search").Hit<THit>[][];

package/dist/umd/index.development.js

@@ -1,4 +1,4 @@
-/*! @algolia/autocomplete-core 1.11.1 | MIT License | © Algolia, Inc. and contributors | https://github.com/algolia/autocomplete */
+/*! @algolia/autocomplete-core 1.12.1 | MIT License | © Algolia, Inc. and contributors | https://github.com/algolia/autocomplete */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
   typeof define === 'function' && define.amd ? define(['exports'], factory) :
@@ -291,7 +291,7 @@
     return undefined;
   }
 
-  var version = '1.11.1';
+  var version = '1.12.1';
 
   var userAgents = [{
     segment: 'autocomplete-core',
@@ -824,7 +824,8 @@
       providedInsightsClient = _getOptions.insightsClient,
       onItemsChange = _getOptions.onItemsChange,
       onSelectEvent = _getOptions.onSelect,
-      onActiveEvent = _getOptions.onActive;
+      onActiveEvent = _getOptions.onActive,
+      __autocomplete_clickAnalytics = _getOptions.__autocomplete_clickAnalytics;
     var insightsClient = providedInsightsClient;
     if (!providedInsightsClient) {
       safelyRunOnBrowser(function (_ref2) {
@@ -887,9 +888,9 @@
         function setInsightsContext(userToken) {
           setContext({
             algoliaInsightsPlugin: {
-              __algoliaSearchParameters: _objectSpread({
+              __algoliaSearchParameters: _objectSpread(_objectSpread({}, __autocomplete_clickAnalytics ? {
                 clickAnalytics: true
-              }, userToken ? {
+              } : {}), userToken ? {
                 userToken: userToken
               } : {}),
               insights: insights
@@ -954,27 +955,36 @@
       __autocomplete_pluginOptions: options
     };
   }
+  function getAlgoliaSources() {
+    var _context$algoliaInsig;
+    var algoliaSourceBase = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+    var context = arguments.length > 1 ? arguments[1] : undefined;
+    return [].concat(_toConsumableArray(algoliaSourceBase), ['autocomplete-internal'], _toConsumableArray((_context$algoliaInsig = context.algoliaInsightsPlugin) !== null && _context$algoliaInsig !== void 0 && _context$algoliaInsig.__automaticInsights ? ['autocomplete-automatic'] : []));
+  }
   function getOptions(options) {
     return _objectSpread({
       onItemsChange: function onItemsChange(_ref8) {
         var insights = _ref8.insights,
-          insightsEvents = _ref8.insightsEvents;
+          insightsEvents = _ref8.insightsEvents,
+          state = _ref8.state;
         insights.viewedObjectIDs.apply(insights, _toConsumableArray(insightsEvents.map(function (event) {
           return _objectSpread(_objectSpread({}, event), {}, {
-            algoliaSource: [].concat(_toConsumableArray(event.algoliaSource || []), ['autocomplete-internal'])
+            algoliaSource: getAlgoliaSources(event.algoliaSource, state.context)
           });
         })));
       },
       onSelect: function onSelect(_ref9) {
         var insights = _ref9.insights,
-          insightsEvents = _ref9.insightsEvents;
+          insightsEvents = _ref9.insightsEvents,
+          state = _ref9.state;
         insights.clickedObjectIDsAfterSearch.apply(insights, _toConsumableArray(insightsEvents.map(function (event) {
           return _objectSpread(_objectSpread({}, event), {}, {
-            algoliaSource: [].concat(_toConsumableArray(event.algoliaSource || []), ['autocomplete-internal'])
+            algoliaSource: getAlgoliaSources(event.algoliaSource, state.context)
           });
         })));
       },
-      onActive: noop
+      onActive: noop,
+      __autocomplete_clickAnalytics: true
     }, options);
   }
   function loadInsights(environment) {
@@ -1378,7 +1388,7 @@
       autoFocus: false,
       defaultActiveItemId: null,
       stallThreshold: 300,
-      insights: false,
+      insights: undefined,
       environment: environment,
       shouldPanelOpen: function shouldPanelOpen(_ref) {
         var state = _ref.state;
@@ -1639,7 +1649,8 @@
       setIsOpen = setters.setIsOpen,
       setQuery = setters.setQuery,
       setActiveItemId = setters.setActiveItemId,
-      setStatus = setters.setStatus;
+      setStatus = setters.setStatus,
+      setContext = setters.setContext;
     setQuery(query);
     setActiveItemId(props.defaultActiveItemId);
     if (!query && props.openOnFocus === false) {
@@ -1689,6 +1700,20 @@
           return preResolve(itemsOrDescription, source.sourceId, store.getState());
         });
       })).then(resolve).then(function (responses) {
+        var __automaticInsights = responses.some(function (_ref2) {
+          var items = _ref2.items;
+          return isSearchResponseWithAutomaticInsightsFlag(items);
+        });
+
+        // No need to pollute the context if `__automaticInsights=false`
+        if (__automaticInsights) {
+          var _store$getState$conte;
+          setContext({
+            algoliaInsightsPlugin: _objectSpread2(_objectSpread2({}, ((_store$getState$conte = store.getState().context) === null || _store$getState$conte === void 0 ? void 0 : _store$getState$conte.algoliaInsightsPlugin) || {}), {}, {
+              __automaticInsights: __automaticInsights
+            })
+          });
+        }
         return postResolve(responses, sources, store);
       }).then(function (collections) {
         return reshape({
@@ -1734,6 +1759,9 @@
     });
     return store.pendingRequests.add(request);
   }
+  function isSearchResponseWithAutomaticInsightsFlag(items) {
+    return !Array.isArray(items) && Boolean(items === null || items === void 0 ? void 0 : items._automaticInsights);
+  }
 
   var _excluded$1 = ["event", "props", "refresh", "store"];
   function onKeyDown(_ref) {
@@ -1815,7 +1843,7 @@
     } else if (event.key === 'Tab') {
       store.dispatch('blur', null);
 
-      // Hitting the `Escape` key signals the end of a user interaction with the
+      // Hitting the `Tab` key signals the end of a user interaction with the
       // autocomplete. At this point, we should ignore any requests that are still
       // pending and could reopen the panel once they resolve, because that would
       // result in an unsolicited UI behavior.
@@ -2367,6 +2395,7 @@
             // we lose track of the highlighted index. (Query-suggestions use-case)
             action.props.openOnFocus === true ? action.props.defaultActiveItemId : null,
             status: 'idle',
+            completion: null,
             query: ''
           });
         }
@@ -2422,6 +2451,7 @@
       navigator: props.navigator
     }, setters));
     function onStoreStateChange(_ref) {
+      var _state$context, _state$context$algoli;
       var prevState = _ref.prevState,
         state = _ref.state;
       props.onStateChange(_objectSpread2({
@@ -2430,6 +2460,13 @@
         refresh: refresh,
         navigator: props.navigator
       }, setters));
+      if (!isAlgoliaInsightsPluginEnabled() && (_state$context = state.context) !== null && _state$context !== void 0 && (_state$context$algoli = _state$context.algoliaInsightsPlugin) !== null && _state$context$algoli !== void 0 && _state$context$algoli.__automaticInsights && props.insights !== false) {
+        var plugin = createAlgoliaInsightsPlugin({
+          __autocomplete_clickAnalytics: false
+        });
+        props.plugins.push(plugin);
+        subscribePlugins([plugin]);
+      }
     }
     function refresh() {
       return onInput(_objectSpread2({
@@ -2444,34 +2481,40 @@
         store: store
       }, setters));
     }
-    if (options.insights && !props.plugins.some(function (plugin) {
-      return plugin.name === 'aa.algoliaInsightsPlugin';
-    })) {
-      var insightsParams = typeof options.insights === 'boolean' ? {} : options.insights;
+    function subscribePlugins(plugins) {
+      plugins.forEach(function (plugin) {
+        var _plugin$subscribe;
+        return (_plugin$subscribe = plugin.subscribe) === null || _plugin$subscribe === void 0 ? void 0 : _plugin$subscribe.call(plugin, _objectSpread2(_objectSpread2({}, setters), {}, {
+          navigator: props.navigator,
+          refresh: refresh,
+          onSelect: function onSelect(fn) {
+            subscribers.push({
+              onSelect: fn
+            });
+          },
+          onActive: function onActive(fn) {
+            subscribers.push({
+              onActive: fn
+            });
+          },
+          onResolve: function onResolve(fn) {
+            subscribers.push({
+              onResolve: fn
+            });
+          }
+        }));
+      });
+    }
+    function isAlgoliaInsightsPluginEnabled() {
+      return props.plugins.some(function (plugin) {
+        return plugin.name === 'aa.algoliaInsightsPlugin';
+      });
+    }
+    if (props.insights && !isAlgoliaInsightsPluginEnabled()) {
+      var insightsParams = typeof props.insights === 'boolean' ? {} : props.insights;
       props.plugins.push(createAlgoliaInsightsPlugin(insightsParams));
     }
-    props.plugins.forEach(function (plugin) {
-      var _plugin$subscribe;
-      return (_plugin$subscribe = plugin.subscribe) === null || _plugin$subscribe === void 0 ? void 0 : _plugin$subscribe.call(plugin, _objectSpread2(_objectSpread2({}, setters), {}, {
-        navigator: props.navigator,
-        refresh: refresh,
-        onSelect: function onSelect(fn) {
-          subscribers.push({
-            onSelect: fn
-          });
-        },
-        onActive: function onActive(fn) {
-          subscribers.push({
-            onActive: fn
-          });
-        },
-        onResolve: function onResolve(fn) {
-          subscribers.push({
-            onResolve: fn
-          });
-        }
-      }));
-    });
+    subscribePlugins(props.plugins);
     injectMetadata({
       metadata: getMetadata({
         plugins: props.plugins,