@algolia/autocomplete-core 1.2.2 → 1.5.0

package/dist/esm/createAutocomplete.d.ts

@@ -1,2 +1,8 @@
-import { AutocompleteApi, AutocompleteOptions, BaseItem } from './types';
-export declare function createAutocomplete<TItem extends BaseItem, TEvent = Event, TMouseEvent = MouseEvent, TKeyboardEvent = KeyboardEvent>(options: AutocompleteOptions<TItem>): AutocompleteApi<TItem, TEvent, TMouseEvent, TKeyboardEvent>;
+import { AutocompleteApi, AutocompleteOptions as AutocompleteCoreOptions, BaseItem } from './types';
+export interface AutocompleteOptionsWithMetadata<TItem extends BaseItem> extends AutocompleteCoreOptions<TItem> {
+    /**
+     * @internal
+     */
+    __autocomplete_metadata?: Record<string, unknown>;
+}
+export declare function createAutocomplete<TItem extends BaseItem, TEvent = Event, TMouseEvent = MouseEvent, TKeyboardEvent = KeyboardEvent>(options: AutocompleteOptionsWithMetadata<TItem>): AutocompleteApi<TItem, TEvent, TMouseEvent, TKeyboardEvent>;

package/dist/esm/createAutocomplete.js

@@ -1,4 +1,4 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
@@ -9,6 +9,7 @@ import { createStore } from './createStore';
 import { getAutocompleteSetters } from './getAutocompleteSetters';
 import { getDefaultProps } from './getDefaultProps';
 import { getPropGetters } from './getPropGetters';
+import { getMetadata, injectMetadata } from './metadata';
 import { onInput } from './onInput';
 import { stateReducer } from './stateReducer';
 export function createAutocomplete(options) {
@@ -65,6 +66,13 @@ export function createAutocomplete(options) {
       }
     }));
   });
+  injectMetadata({
+    metadata: getMetadata({
+      plugins: props.plugins,
+      options: options
+    }),
+    environment: props.environment
+  });
   return _objectSpread(_objectSpread({
     refresh: refresh
   }, propGetters), setters);

package/dist/esm/createStore.js

@@ -1,4 +1,4 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 

package/dist/esm/getAutocompleteSetters.js

@@ -1,10 +1,10 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import { flatten } from './utils';
+import { flatten } from '@algolia/autocomplete-shared';
 export function getAutocompleteSetters(_ref) {
   var store = _ref.store;
 

package/dist/esm/getDefaultProps.js

@@ -4,20 +4,20 @@ function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread n
 
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 
-function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
 
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
 
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import { getItemsCount, generateAutocompleteId } from '@algolia/autocomplete-shared';
-import { getNormalizedSources, flatten } from './utils';
+import { getItemsCount, generateAutocompleteId, flatten } from '@algolia/autocomplete-shared';
+import { getNormalizedSources } from './utils';
 export function getDefaultProps(props, pluginSubscribers) {
   var _props$id;
 
@@ -37,6 +37,10 @@ export function getDefaultProps(props, pluginSubscribers) {
     shouldPanelOpen: function shouldPanelOpen(_ref) {
       var state = _ref.state;
       return getItemsCount(state) > 0;
+    },
+    reshape: function reshape(_ref2) {
+      var sources = _ref2.sources;
+      return sources;
     }
   }, props), {}, {
     // Since `generateAutocompleteId` triggers a side effect (it increments
@@ -114,17 +118,17 @@ export function getDefaultProps(props, pluginSubscribers) {
       });
     },
     navigator: _objectSpread({
-      navigate: function navigate(_ref2) {
-        var itemUrl = _ref2.itemUrl;
+      navigate: function navigate(_ref3) {
+        var itemUrl = _ref3.itemUrl;
         environment.location.assign(itemUrl);
       },
-      navigateNewTab: function navigateNewTab(_ref3) {
-        var itemUrl = _ref3.itemUrl;
+      navigateNewTab: function navigateNewTab(_ref4) {
+        var itemUrl = _ref4.itemUrl;
         var windowReference = environment.open(itemUrl, '_blank', 'noopener');
         windowReference === null || windowReference === void 0 ? void 0 : windowReference.focus();
       },
-      navigateNewWindow: function navigateNewWindow(_ref4) {
-        var itemUrl = _ref4.itemUrl;
+      navigateNewWindow: function navigateNewWindow(_ref5) {
+        var itemUrl = _ref5.itemUrl;
         environment.open(itemUrl, '_blank', 'noopener');
       }
     }, props.navigator)

package/dist/esm/getPropGetters.js

@@ -1,4 +1,10 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+var _excluded = ["props", "refresh", "store"],
+    _excluded2 = ["inputElement", "formElement", "panelElement"],
+    _excluded3 = ["inputElement"],
+    _excluded4 = ["inputElement", "maxLength"],
+    _excluded5 = ["item", "source"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
@@ -15,13 +21,13 @@ export function getPropGetters(_ref) {
   var props = _ref.props,
       refresh = _ref.refresh,
       store = _ref.store,
-      setters = _objectWithoutProperties(_ref, ["props", "refresh", "store"]);
+      setters = _objectWithoutProperties(_ref, _excluded);
 
   var getEnvironmentProps = function getEnvironmentProps(providedProps) {
     var inputElement = providedProps.inputElement,
         formElement = providedProps.formElement,
         panelElement = providedProps.panelElement,
-        rest = _objectWithoutProperties(providedProps, ["inputElement", "formElement", "panelElement"]);
+        rest = _objectWithoutProperties(providedProps, _excluded2);
 
     return _objectSpread({
       // On touch devices, we do not rely on the native `blur` event of the
@@ -29,15 +35,15 @@ export function getPropGetters(_ref) {
       // outside of the autocomplete elements.
       // This ensures a working experience on mobile because we blur the input
       // on touch devices when the user starts scrolling (`touchmove`).
+      // @TODO: support cases where there are multiple Autocomplete instances.
+      // Right now, a second instance makes this computation return false.
       onTouchStart: function onTouchStart(event) {
         if (store.getState().isOpen === false || event.target === inputElement) {
           return;
-        } // @TODO: support cases where there are multiple Autocomplete instances.
-        // Right now, a second instance makes this computation return false.
-
+        }
 
         var isTargetWithinAutocomplete = [formElement, panelElement].some(function (contextNode) {
-          return isOrContainsNode(contextNode, event.target) || isOrContainsNode(contextNode, props.environment.document.activeElement);
+          return isOrContainsNode(contextNode, event.target);
         });
 
         if (isTargetWithinAutocomplete === false) {
@@ -70,7 +76,7 @@ export function getPropGetters(_ref) {
 
   var getFormProps = function getFormProps(providedProps) {
     var inputElement = providedProps.inputElement,
-        rest = _objectWithoutProperties(providedProps, ["inputElement"]);
+        rest = _objectWithoutProperties(providedProps, _excluded3);
 
     return _objectSpread({
       action: '',
@@ -126,7 +132,7 @@ export function getPropGetters(_ref) {
         inputElement = _ref2.inputElement,
         _ref2$maxLength = _ref2.maxLength,
         maxLength = _ref2$maxLength === void 0 ? 512 : _ref2$maxLength,
-        rest = _objectWithoutProperties(_ref2, ["inputElement", "maxLength"]);
+        rest = _objectWithoutProperties(_ref2, _excluded4);
 
     var activeItem = getActiveItem(store.getState());
     return _objectSpread({
@@ -217,7 +223,7 @@ export function getPropGetters(_ref) {
   var getItemProps = function getItemProps(providedProps) {
     var item = providedProps.item,
         source = providedProps.source,
-        rest = _objectWithoutProperties(providedProps, ["item", "source"]);
+        rest = _objectWithoutProperties(providedProps, _excluded5);
 
     return _objectSpread({
       id: "".concat(props.id, "-item-").concat(item.__autocomplete_id),

package/dist/esm/index.d.ts

@@ -1,4 +1,3 @@
 export * from './createAutocomplete';
 export * from './getDefaultProps';
 export * from './types';
-export * from './version';

package/dist/esm/index.js

@@ -1,4 +1,3 @@
 export * from './createAutocomplete';
 export * from './getDefaultProps';
-export * from './types';
-export * from './version';
+export * from './types';

package/dist/esm/metadata.d.ts

@@ -0,0 +1,33 @@
+import { UserAgent } from '@algolia/autocomplete-shared';
+import { AutocompleteEnvironment, AutocompleteOptionsWithMetadata, AutocompletePlugin, BaseItem } from '.';
+declare type AutocompleteMetadata = {
+    plugins: Array<{
+        name: string | undefined;
+        options: string[];
+    }>;
+    options: Record<string, string[]>;
+    ua: UserAgent[];
+};
+declare type GetMetadataParams<TItem extends BaseItem, TData = unknown> = {
+    plugins: Array<AutocompletePlugin<TItem, TData>>;
+    options: AutocompleteOptionsWithMetadata<TItem>;
+};
+export declare function getMetadata<TItem extends BaseItem, TData = unknown>({ plugins, options, }: GetMetadataParams<TItem, TData>): {
+    plugins: {
+        name: string | undefined;
+        options: string[];
+    }[];
+    options: {
+        'autocomplete-core': string[];
+    };
+    ua: {
+        segment: string;
+        version: string;
+    }[];
+};
+declare type InlineMetadataParams = {
+    metadata: AutocompleteMetadata;
+    environment: AutocompleteEnvironment;
+};
+export declare function injectMetadata({ metadata, environment, }: InlineMetadataParams): void;
+export {};

package/dist/esm/metadata.js

@@ -0,0 +1,44 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import { userAgents } from '@algolia/autocomplete-shared';
+export function getMetadata(_ref) {
+  var _, _options$__autocomple, _options$__autocomple2, _options$__autocomple3;
+
+  var plugins = _ref.plugins,
+      options = _ref.options;
+  var optionsKey = (_ = (((_options$__autocomple = options.__autocomplete_metadata) === null || _options$__autocomple === void 0 ? void 0 : _options$__autocomple.userAgents) || [])[0]) === null || _ === void 0 ? void 0 : _.segment;
+  var extraOptions = optionsKey ? _defineProperty({}, optionsKey, Object.keys(((_options$__autocomple2 = options.__autocomplete_metadata) === null || _options$__autocomple2 === void 0 ? void 0 : _options$__autocomple2.options) || {})) : {};
+  return {
+    plugins: plugins.map(function (plugin) {
+      return {
+        name: plugin.name,
+        options: Object.keys(plugin.__autocomplete_pluginOptions || [])
+      };
+    }),
+    options: _objectSpread({
+      'autocomplete-core': Object.keys(options)
+    }, extraOptions),
+    ua: userAgents.concat(((_options$__autocomple3 = options.__autocomplete_metadata) === null || _options$__autocomple3 === void 0 ? void 0 : _options$__autocomple3.userAgents) || [])
+  };
+}
+export function injectMetadata(_ref3) {
+  var _environment$navigato;
+
+  var metadata = _ref3.metadata,
+      environment = _ref3.environment;
+  var isMetadataEnabled = (_environment$navigato = environment.navigator) === null || _environment$navigato === void 0 ? void 0 : _environment$navigato.userAgent.includes('Algolia Crawler');
+
+  if (isMetadataEnabled) {
+    var metadataContainer = environment.document.createElement('meta');
+    var headRef = environment.document.querySelector('head');
+    metadataContainer.name = 'algolia:metadata';
+    setTimeout(function () {
+      metadataContainer.content = JSON.stringify(metadata);
+      headRef.appendChild(metadataContainer);
+    }, 0);
+  }
+}

package/dist/esm/onInput.js

@@ -1,4 +1,6 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+var _excluded = ["event", "nextState", "props", "query", "refresh", "store"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
@@ -8,9 +10,11 @@ function _objectWithoutProperties(source, excluded) { if (source == null) return
 
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 
+import { reshape } from './reshape';
 import { preResolve, resolve, postResolve } from './resolve';
-import { getActiveItem } from './utils';
+import { createConcurrentSafePromise, getActiveItem } from './utils';
 var lastStalledId = null;
+var runConcurrentSafePromise = createConcurrentSafePromise();
 export function onInput(_ref) {
   var event = _ref.event,
       _ref$nextState = _ref.nextState,
@@ -19,7 +23,7 @@ export function onInput(_ref) {
       query = _ref.query,
       refresh = _ref.refresh,
       store = _ref.store,
-      setters = _objectWithoutProperties(_ref, ["event", "nextState", "props", "query", "refresh", "store"]);
+      setters = _objectWithoutProperties(_ref, _excluded);
 
   if (lastStalledId) {
     props.environment.clearTimeout(lastStalledId);
@@ -36,28 +40,40 @@ export function onInput(_ref) {
   if (!query && props.openOnFocus === false) {
     var _nextState$isOpen;
 
-    setStatus('idle');
-    setCollections(store.getState().collections.map(function (collection) {
+    var collections = store.getState().collections.map(function (collection) {
       return _objectSpread(_objectSpread({}, collection), {}, {
         items: []
       });
-    }));
+    });
+    setStatus('idle');
+    setCollections(collections);
     setIsOpen((_nextState$isOpen = nextState.isOpen) !== null && _nextState$isOpen !== void 0 ? _nextState$isOpen : props.shouldPanelOpen({
       state: store.getState()
-    }));
-    return Promise.resolve();
+    })); // We make sure to update the latest resolved value of the tracked
+    // promises to keep late resolving promises from "cancelling" the state
+    // updates performed in this code path.
+    // We chain with a void promise to respect `onInput`'s expected return type.
+
+    return runConcurrentSafePromise(collections).then(function () {
+      return Promise.resolve();
+    });
   }
 
   setStatus('loading');
   lastStalledId = props.environment.setTimeout(function () {
     setStatus('stalled');
-  }, props.stallThreshold);
-  return props.getSources(_objectSpread({
+  }, props.stallThreshold); // We track the entire promise chain triggered by `onInput` before mutating
+  // the Autocomplete state to make sure that any state manipulation is based on
+  // fresh data regardless of when promises individually resolve.
+  // We don't track nested promises and only rely on the full chain resolution,
+  // meaning we should only ever manipulate the state once this concurrent-safe
+  // promise is resolved.
+
+  return runConcurrentSafePromise(props.getSources(_objectSpread({
     query: query,
     refresh: refresh,
     state: store.getState()
   }, setters)).then(function (sources) {
-    setStatus('loading');
     return Promise.all(sources.map(function (source) {
       return Promise.resolve(source.getItems(_objectSpread({
         query: query,
@@ -69,35 +85,41 @@ export function onInput(_ref) {
     })).then(resolve).then(function (responses) {
       return postResolve(responses, sources);
     }).then(function (collections) {
-      var _nextState$isOpen2;
-
-      setStatus('idle');
-      setCollections(collections);
-      var isPanelOpen = props.shouldPanelOpen({
+      return reshape({
+        collections: collections,
+        props: props,
         state: store.getState()
       });
-      setIsOpen((_nextState$isOpen2 = nextState.isOpen) !== null && _nextState$isOpen2 !== void 0 ? _nextState$isOpen2 : props.openOnFocus && !query && isPanelOpen || isPanelOpen);
-      var highlightedItem = getActiveItem(store.getState());
+    });
+  })).then(function (collections) {
+    var _nextState$isOpen2;
 
-      if (store.getState().activeItemId !== null && highlightedItem) {
-        var item = highlightedItem.item,
-            itemInputValue = highlightedItem.itemInputValue,
-            itemUrl = highlightedItem.itemUrl,
-            source = highlightedItem.source;
-        source.onActive(_objectSpread({
-          event: event,
-          item: item,
-          itemInputValue: itemInputValue,
-          itemUrl: itemUrl,
-          refresh: refresh,
-          source: source,
-          state: store.getState()
-        }, setters));
-      }
-    }).finally(function () {
-      if (lastStalledId) {
-        props.environment.clearTimeout(lastStalledId);
-      }
+    setStatus('idle');
+    setCollections(collections);
+    var isPanelOpen = props.shouldPanelOpen({
+      state: store.getState()
     });
+    setIsOpen((_nextState$isOpen2 = nextState.isOpen) !== null && _nextState$isOpen2 !== void 0 ? _nextState$isOpen2 : props.openOnFocus && !query && isPanelOpen || isPanelOpen);
+    var highlightedItem = getActiveItem(store.getState());
+
+    if (store.getState().activeItemId !== null && highlightedItem) {
+      var item = highlightedItem.item,
+          itemInputValue = highlightedItem.itemInputValue,
+          itemUrl = highlightedItem.itemUrl,
+          source = highlightedItem.source;
+      source.onActive(_objectSpread({
+        event: event,
+        item: item,
+        itemInputValue: itemInputValue,
+        itemUrl: itemUrl,
+        refresh: refresh,
+        source: source,
+        state: store.getState()
+      }, setters));
+    }
+  }).finally(function () {
+    if (lastStalledId) {
+      props.environment.clearTimeout(lastStalledId);
+    }
   });
 }

package/dist/esm/onKeyDown.js

@@ -1,4 +1,6 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+var _excluded = ["event", "props", "refresh", "store"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
@@ -15,7 +17,7 @@ export function onKeyDown(_ref) {
       props = _ref.props,
       refresh = _ref.refresh,
       store = _ref.store,
-      setters = _objectWithoutProperties(_ref, ["event", "props", "refresh", "store"]);
+      setters = _objectWithoutProperties(_ref, _excluded);
 
   if (event.key === 'ArrowUp' || event.key === 'ArrowDown') {
     // eslint-disable-next-line no-inner-declarations

package/dist/esm/reshape.d.ts

@@ -0,0 +1,11 @@
+import { AutocompleteCollection, AutocompleteState, BaseItem, InternalAutocompleteOptions } from './types';
+declare type ReshapeParams<TItem extends BaseItem> = {
+    collections: Array<AutocompleteCollection<any>>;
+    props: InternalAutocompleteOptions<TItem>;
+    state: AutocompleteState<TItem>;
+};
+export declare function reshape<TItem extends BaseItem>({ collections, props, state, }: ReshapeParams<TItem>): {
+    source: import("./types").AutocompleteReshapeSource<TItem>;
+    items: TItem[];
+}[];
+export {};

package/dist/esm/reshape.js

@@ -0,0 +1,34 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import { flatten } from '@algolia/autocomplete-shared';
+export function reshape(_ref) {
+  var collections = _ref.collections,
+      props = _ref.props,
+      state = _ref.state;
+  // Sources are grouped by `sourceId` to conveniently pick them via destructuring.
+  // Example: `const { recentSearchesPlugin } = sourcesBySourceId`
+  var sourcesBySourceId = collections.reduce(function (acc, collection) {
+    return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, collection.source.sourceId, _objectSpread(_objectSpread({}, collection.source), {}, {
+      getItems: function getItems() {
+        // We provide the resolved items from the collection to the `reshape` prop.
+        return flatten(collection.items);
+      }
+    })));
+  }, {});
+  var reshapeSources = props.reshape({
+    sources: Object.values(sourcesBySourceId),
+    sourcesBySourceId: sourcesBySourceId,
+    state: state
+  }); // We reconstruct the collections with the items modified by the `reshape` prop.
+
+  return flatten(reshapeSources).filter(Boolean).map(function (source) {
+    return {
+      source: source,
+      items: source.getItems()
+    };
+  });
+}

package/dist/esm/resolve.js

@@ -6,20 +6,20 @@ function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread n
 
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 
-function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
 
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
 
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import { invariant } from '@algolia/autocomplete-shared';
-import { flatten, mapToAlgoliaResponse } from './utils';
+import { decycle, flatten, invariant } from '@algolia/autocomplete-shared';
+import { mapToAlgoliaResponse } from './utils';
 
 function isDescription(item) {
   return Boolean(item.execute);
@@ -105,7 +105,9 @@ export function postResolve(responses, sources) {
     });
     var transform = matches[0].transformResponse;
     var items = transform ? transform(mapToAlgoliaResponse(results)) : results;
-    invariant(Array.isArray(items), "The `getItems` function from source \"".concat(source.sourceId, "\" must return an array of items but returned type ").concat(JSON.stringify(_typeof(items)), ":\n\n").concat(JSON.stringify(items, null, 2), ".\n\nSee: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/#param-getitems"));
+    invariant(Array.isArray(items), function () {
+      return "The `getItems` function from source \"".concat(source.sourceId, "\" must return an array of items but returned type ").concat(JSON.stringify(_typeof(items)), ":\n\n").concat(JSON.stringify(decycle(items), null, 2), ".\n\nSee: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/#param-getitems");
+    });
     invariant(items.every(Boolean), "The `getItems` function from source \"".concat(source.sourceId, "\" must return an array of items but returned ").concat(JSON.stringify(undefined), ".\n\nDid you forget to return items?\n\nSee: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/#param-getitems"));
     return {
       source: source,

package/dist/esm/stateReducer.js

@@ -1,4 +1,4 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 

package/dist/esm/types/AutocompleteApi.js

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

package/dist/esm/types/AutocompleteCollection.js

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

package/dist/esm/types/AutocompleteContext.js

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

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

@@ -9,4 +9,5 @@ export declare type AutocompleteEnvironment = Window | {
         assign: Location['assign'];
     };
     open: Window['open'];
+    navigator: Window['navigator'];
 };

package/dist/esm/types/AutocompleteEnvironment.js

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

package/dist/esm/types/AutocompleteNavigator.js

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

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

@@ -3,6 +3,7 @@ import { AutocompleteScopeApi, BaseItem } from './AutocompleteApi';
 import { AutocompleteEnvironment } from './AutocompleteEnvironment';
 import { AutocompleteNavigator } from './AutocompleteNavigator';
 import { AutocompletePlugin } from './AutocompletePlugin';
+import { Reshape } from './AutocompleteReshape';
 import { AutocompleteSource, InternalAutocompleteSource } from './AutocompleteSource';
 import { AutocompleteState } from './AutocompleteState';
 export interface OnSubmitParams<TItem extends BaseItem> extends AutocompleteScopeApi<TItem> {
@@ -149,6 +150,16 @@ export interface AutocompleteOptions<TItem extends BaseItem> {
      * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-plugins
      */
     plugins?: Array<AutocompletePlugin<any, any>>;
+    /**
+     * The function called to reshape the sources after they're resolved.
+     *
+     * This is useful to transform sources before rendering them. You can group sources by attribute, remove duplicates, create shared limits between sources, etc.
+     *
+     * See [**Reshaping sources**](https://www.algolia.com/doc/ui-libraries/autocomplete/guides/reshaping-sources/) for more information.
+     *
+     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-reshape
+     */
+    reshape?: Reshape<TItem>;
 }
 export interface InternalAutocompleteOptions<TItem extends BaseItem> extends AutocompleteOptions<TItem> {
     debug: boolean;
@@ -169,5 +180,6 @@ export interface InternalAutocompleteOptions<TItem extends BaseItem> extends Aut
     }): boolean;
     onSubmit(params: OnSubmitParams<TItem>): void;
     onReset(params: OnResetParams<TItem>): void;
+    reshape: Reshape<TItem>;
 }
 export {};

package/dist/esm/types/AutocompleteOptions.js

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

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

@@ -21,5 +21,15 @@ export declare type AutocompletePlugin<TItem extends BaseItem, TData = unknown>
      * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/plugins/#param-data
      */
     data?: TData;
+    /**
+     * A name to identify the plugin.
+     *
+     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/plugins/#param-name
+     */
+    name?: string;
+    /**
+     * @internal
+     */
+    __autocomplete_pluginOptions?: Record<string, any>;
 };
 export {};