@algolia/autocomplete-js 1.18.1 → 1.19.1

package/dist/umd/index.development.js

@@ -1,4 +1,4 @@
-/*! @algolia/autocomplete-js 1.18.1 | MIT License | © Algolia, Inc. and contributors | https://github.com/algolia/autocomplete */
+/*! @algolia/autocomplete-js 1.19.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) :
@@ -118,13 +118,13 @@
     return target;
   }
   function _slicedToArray$2(arr, i) {
-    return _arrayWithHoles$2(arr) || _iterableToArrayLimit$2(arr, i) || _unsupportedIterableToArray$9(arr, i) || _nonIterableRest$2();
+    return _arrayWithHoles$2(arr) || _iterableToArrayLimit$2(arr, i) || _unsupportedIterableToArray$a(arr, i) || _nonIterableRest$2();
   }
   function _toConsumableArray$7(arr) {
-    return _arrayWithoutHoles$7(arr) || _iterableToArray$7(arr) || _unsupportedIterableToArray$9(arr) || _nonIterableSpread$7();
+    return _arrayWithoutHoles$7(arr) || _iterableToArray$7(arr) || _unsupportedIterableToArray$a(arr) || _nonIterableSpread$7();
   }
   function _arrayWithoutHoles$7(arr) {
-    if (Array.isArray(arr)) return _arrayLikeToArray$9(arr);
+    if (Array.isArray(arr)) return _arrayLikeToArray$a(arr);
   }
   function _arrayWithHoles$2(arr) {
     if (Array.isArray(arr)) return arr;
@@ -132,15 +132,15 @@
   function _iterableToArray$7(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
   }
-  function _unsupportedIterableToArray$9(o, minLen) {
+  function _unsupportedIterableToArray$a(o, minLen) {
     if (!o) return;
-    if (typeof o === "string") return _arrayLikeToArray$9(o, minLen);
+    if (typeof o === "string") return _arrayLikeToArray$a(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$9(o, minLen);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray$a(o, minLen);
   }
-  function _arrayLikeToArray$9(arr, len) {
+  function _arrayLikeToArray$a(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;
@@ -188,20 +188,20 @@
   }
 
   function _slicedToArray$1(arr, i) {
-    return _arrayWithHoles$1(arr) || _iterableToArrayLimit$1(arr, i) || _unsupportedIterableToArray$8(arr, i) || _nonIterableRest$1();
+    return _arrayWithHoles$1(arr) || _iterableToArrayLimit$1(arr, i) || _unsupportedIterableToArray$9(arr, i) || _nonIterableRest$1();
   }
   function _nonIterableRest$1() {
     throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
   }
-  function _unsupportedIterableToArray$8(o, minLen) {
+  function _unsupportedIterableToArray$9(o, minLen) {
     if (!o) return;
-    if (typeof o === "string") return _arrayLikeToArray$8(o, minLen);
+    if (typeof o === "string") return _arrayLikeToArray$9(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$8(o, minLen);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray$9(o, minLen);
   }
-  function _arrayLikeToArray$8(arr, len) {
+  function _arrayLikeToArray$9(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;
@@ -347,7 +347,7 @@
     return undefined;
   }
 
-  var version = '1.18.1';
+  var version = '1.19.1';
 
   var userAgents$1 = [{
     segment: 'autocomplete-core',
@@ -392,20 +392,20 @@
   }
 
   function _slicedToArray(arr, i) {
-    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray$7(arr, i) || _nonIterableRest();
+    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray$8(arr, i) || _nonIterableRest();
   }
   function _nonIterableRest() {
     throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
   }
-  function _unsupportedIterableToArray$7(o, minLen) {
+  function _unsupportedIterableToArray$8(o, minLen) {
     if (!o) return;
-    if (typeof o === "string") return _arrayLikeToArray$7(o, minLen);
+    if (typeof o === "string") return _arrayLikeToArray$8(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$7(o, minLen);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray$8(o, minLen);
   }
-  function _arrayLikeToArray$7(arr, len) {
+  function _arrayLikeToArray$8(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;
@@ -470,26 +470,26 @@
     }, _typeof$g(obj);
   }
   function _toConsumableArray$6(arr) {
-    return _arrayWithoutHoles$6(arr) || _iterableToArray$6(arr) || _unsupportedIterableToArray$6(arr) || _nonIterableSpread$6();
+    return _arrayWithoutHoles$6(arr) || _iterableToArray$6(arr) || _unsupportedIterableToArray$7(arr) || _nonIterableSpread$6();
   }
   function _nonIterableSpread$6() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
   }
-  function _unsupportedIterableToArray$6(o, minLen) {
+  function _unsupportedIterableToArray$7(o, minLen) {
     if (!o) return;
-    if (typeof o === "string") return _arrayLikeToArray$6(o, minLen);
+    if (typeof o === "string") return _arrayLikeToArray$7(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$6(o, minLen);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray$7(o, minLen);
   }
   function _iterableToArray$6(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
   }
   function _arrayWithoutHoles$6(arr) {
-    if (Array.isArray(arr)) return _arrayLikeToArray$6(arr);
+    if (Array.isArray(arr)) return _arrayLikeToArray$7(arr);
   }
-  function _arrayLikeToArray$6(arr, len) {
+  function _arrayLikeToArray$7(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;
@@ -791,26 +791,26 @@
     }, _typeof$f(obj);
   }
   function _toConsumableArray$5(arr) {
-    return _arrayWithoutHoles$5(arr) || _iterableToArray$5(arr) || _unsupportedIterableToArray$5(arr) || _nonIterableSpread$5();
+    return _arrayWithoutHoles$5(arr) || _iterableToArray$5(arr) || _unsupportedIterableToArray$6(arr) || _nonIterableSpread$5();
   }
   function _nonIterableSpread$5() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
   }
-  function _unsupportedIterableToArray$5(o, minLen) {
+  function _unsupportedIterableToArray$6(o, minLen) {
     if (!o) return;
-    if (typeof o === "string") return _arrayLikeToArray$5(o, minLen);
+    if (typeof o === "string") return _arrayLikeToArray$6(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$5(o, minLen);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray$6(o, minLen);
   }
   function _iterableToArray$5(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
   }
   function _arrayWithoutHoles$5(arr) {
-    if (Array.isArray(arr)) return _arrayLikeToArray$5(arr);
+    if (Array.isArray(arr)) return _arrayLikeToArray$6(arr);
   }
-  function _arrayLikeToArray$5(arr, len) {
+  function _arrayLikeToArray$6(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;
@@ -1146,6 +1146,9 @@
     };
   }
 
+  // Ensures multiple callers sync to the same promise.
+  var _hasWaitPromiseResolved = true;
+  var _waitPromise;
   function createCancelablePromiseList() {
     var list = [];
     return {
@@ -1164,6 +1167,22 @@
       },
       isEmpty: function isEmpty() {
         return list.length === 0;
+      },
+      wait: function wait(timeout) {
+        // Reuse promise if already exists. Keeps multiple callers subscribed to the same promise.
+        if (!_hasWaitPromiseResolved) {
+          return _waitPromise;
+        }
+
+        // Creates a promise which either resolves after all pending requests complete
+        // or the timeout is reached (if provided). Whichever comes first.
+        _hasWaitPromiseResolved = false;
+        _waitPromise = !timeout ? Promise.all(list) : Promise.race([Promise.all(list), new Promise(function (resolve) {
+          return setTimeout(resolve, timeout);
+        })]);
+        return _waitPromise.then(function () {
+          _hasWaitPromiseResolved = true;
+        });
       }
     };
   }
@@ -1335,6 +1354,105 @@
     });
   }
 
+  function _createForOfIteratorHelper(o, allowArrayLike) {
+    var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"];
+    if (!it) {
+      if (Array.isArray(o) || (it = _unsupportedIterableToArray$5(o)) || allowArrayLike && o && typeof o.length === "number") {
+        if (it) o = it;
+        var i = 0;
+        var F = function F() {};
+        return {
+          s: F,
+          n: function n() {
+            if (i >= o.length) return {
+              done: true
+            };
+            return {
+              done: false,
+              value: o[i++]
+            };
+          },
+          e: function e(_e) {
+            throw _e;
+          },
+          f: F
+        };
+      }
+      throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+    }
+    var normalCompletion = true,
+      didErr = false,
+      err;
+    return {
+      s: function s() {
+        it = it.call(o);
+      },
+      n: function n() {
+        var step = it.next();
+        normalCompletion = step.done;
+        return step;
+      },
+      e: function e(_e2) {
+        didErr = true;
+        err = _e2;
+      },
+      f: function f() {
+        try {
+          if (!normalCompletion && it.return != null) it.return();
+        } finally {
+          if (didErr) throw err;
+        }
+      }
+    };
+  }
+  function _unsupportedIterableToArray$5(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _arrayLikeToArray$5(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$5(o, minLen);
+  }
+  function _arrayLikeToArray$5(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;
+  }
+  /**
+   * If a plugin is configured to await a submit event, this returns a promise
+   * for either the max timeout value found or until it completes.
+   * Otherwise, return undefined.
+   */
+  var getPluginSubmitPromise = function getPluginSubmitPromise(plugins, pendingRequests) {
+    var waitUntilComplete = false;
+    var timeouts = [];
+    var _iterator = _createForOfIteratorHelper(plugins),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var _plugin$__autocomplet, _plugin$__autocomplet2, _plugin$__autocomplet3;
+        var plugin = _step.value;
+        var value = (_plugin$__autocomplet = plugin.__autocomplete_pluginOptions) === null || _plugin$__autocomplet === void 0 ? void 0 : (_plugin$__autocomplet2 = (_plugin$__autocomplet3 = _plugin$__autocomplet).awaitSubmit) === null || _plugin$__autocomplet2 === void 0 ? void 0 : _plugin$__autocomplet2.call(_plugin$__autocomplet3);
+        if (typeof value === 'number') {
+          timeouts.push(value);
+        } else if (value === true) {
+          waitUntilComplete = true;
+          break; // break loop as bool overrides num array below
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+    if (waitUntilComplete) {
+      return pendingRequests.wait();
+    } else if (timeouts.length > 0) {
+      return pendingRequests.wait(Math.max.apply(Math, timeouts));
+    }
+    return undefined;
+  };
+
   // We don't have access to the autocomplete source when we call `onKeyDown`
   // or `onClick` because those are native browser events.
   // However, we can get the source from the suggestion index.
@@ -2516,11 +2634,14 @@
       if (store.getState().activeItemId === null || store.getState().collections.every(function (collection) {
         return collection.items.length === 0;
       })) {
-        // If requests are still pending when the panel closes, they could reopen
-        // the panel once they resolve.
-        // We want to prevent any subsequent query from reopening the panel
-        // because it would result in an unsolicited UI behavior.
-        if (!props.debug) {
+        var waitForSubmit = getPluginSubmitPromise(props.plugins, store.pendingRequests);
+        if (waitForSubmit !== undefined) {
+          waitForSubmit.then(store.pendingRequests.cancelAll); // Cancel the rest if timeout number is provided
+        } else if (!props.debug) {
+          // If requests are still pending when the panel closes, they could reopen
+          // the panel once they resolve.
+          // We want to prevent any subsequent query from reopening the panel
+          // because it would result in an unsolicited UI behavior.
           store.pendingRequests.cancelAll();
         }
         return;
@@ -2779,20 +2900,30 @@
     var getFormProps = function getFormProps(providedProps) {
       providedProps.inputElement;
         var rest = _objectWithoutProperties$1(providedProps, _excluded3);
+      var handleSubmit = function handleSubmit(event) {
+        var _providedProps$inputE;
+        props.onSubmit(_objectSpread$6({
+          event: event,
+          refresh: refresh,
+          state: store.getState()
+        }, setters));
+        store.dispatch('submit', null);
+        (_providedProps$inputE = providedProps.inputElement) === null || _providedProps$inputE === void 0 ? void 0 : _providedProps$inputE.blur();
+      };
       return _objectSpread$6({
         action: '',
         noValidate: true,
         role: 'search',
         onSubmit: function onSubmit(event) {
-          var _providedProps$inputE;
           event.preventDefault();
-          props.onSubmit(_objectSpread$6({
-            event: event,
-            refresh: refresh,
-            state: store.getState()
-          }, setters));
-          store.dispatch('submit', null);
-          (_providedProps$inputE = providedProps.inputElement) === null || _providedProps$inputE === void 0 ? void 0 : _providedProps$inputE.blur();
+          var waitForSubmit = getPluginSubmitPromise(props.plugins, store.pendingRequests);
+          if (waitForSubmit !== undefined) {
+            waitForSubmit.then(function () {
+              return handleSubmit(event);
+            });
+          } else {
+            handleSubmit(event);
+          }
         },
         onReset: function onReset(event) {
           var _providedProps$inputE2;