@algolia/autocomplete-core 1.18.1 → 1.19.0

package/dist/esm/getPropGetters.js

@@ -15,7 +15,7 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
 import { noop } from '@algolia/autocomplete-shared';
 import { onInput } from './onInput';
 import { onKeyDown as _onKeyDown } from './onKeyDown';
-import { getActiveItem, getAutocompleteElementId, isOrContainsNode, isSamsung, getNativeEvent } from './utils';
+import { getPluginSubmitPromise, getActiveItem, getAutocompleteElementId, isOrContainsNode, isSamsung, getNativeEvent } from './utils';
 export function getPropGetters(_ref) {
   var props = _ref.props,
     refresh = _ref.refresh,
@@ -94,20 +94,30 @@ export function getPropGetters(_ref) {
   var getFormProps = function getFormProps(providedProps) {
     var inputElement = providedProps.inputElement,
       rest = _objectWithoutProperties(providedProps, _excluded3);
+    var handleSubmit = function handleSubmit(event) {
+      var _providedProps$inputE;
+      props.onSubmit(_objectSpread({
+        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({
       action: '',
       noValidate: true,
       role: 'search',
       onSubmit: function onSubmit(event) {
-        var _providedProps$inputE;
         event.preventDefault();
-        props.onSubmit(_objectSpread({
-          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;

package/dist/esm/onKeyDown.js

@@ -8,7 +8,7 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 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 { onInput } from './onInput';
-import { getActiveItem, getAutocompleteElementId } from './utils';
+import { getPluginSubmitPromise, getActiveItem, getAutocompleteElementId } from './utils';
 export function onKeyDown(_ref) {
   var event = _ref.event,
     props = _ref.props,
@@ -99,11 +99,14 @@ export function onKeyDown(_ref) {
     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;

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

@@ -17,5 +17,11 @@ export declare type CancelablePromiseList<TValue> = {
      * Whether there are pending promises in the list.
      */
     isEmpty(): boolean;
+    /**
+     * Waits for all pending promises to be resolved.
+     *
+     * @param timeout Maximum amount of time allowed to wait for pending promises. Returns early if this time is reached.
+     */
+    wait(timeout?: number): Promise<void>;
 };
 export declare function createCancelablePromiseList<TValue>(): CancelablePromiseList<TValue>;

package/dist/esm/utils/createCancelablePromiseList.js

@@ -1,3 +1,6 @@
+// Ensures multiple callers sync to the same promise.
+var _hasWaitPromiseResolved = true;
+var _waitPromise;
 export function createCancelablePromiseList() {
   var list = [];
   return {
@@ -16,6 +19,22 @@ export function createCancelablePromiseList() {
     },
     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;
+      });
     }
   };
 }

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

@@ -0,0 +1,8 @@
+import type { InternalAutocompleteOptions } from '../types';
+import { CancelablePromiseList } from './createCancelablePromiseList';
+/**
+ * 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.
+ */
+export declare const getPluginSubmitPromise: (plugins: InternalAutocompleteOptions<any>['plugins'], pendingRequests: CancelablePromiseList<void>) => Promise<void> | undefined;

package/dist/esm/utils/getPluginSubmitPromise.js

@@ -0,0 +1,37 @@
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(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(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 _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; }
+/**
+ * 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.
+ */
+export 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;
+};

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

@@ -3,6 +3,7 @@ export * from './createCancelablePromiseList';
 export * from './createConcurrentSafePromise';
 export * from './getNextActiveItemId';
 export * from './getNormalizedSources';
+export * from './getPluginSubmitPromise';
 export * from './getActiveItem';
 export * from './getAutocompleteElementId';
 export * from './isOrContainsNode';

package/dist/esm/utils/index.js

@@ -3,6 +3,7 @@ export * from './createCancelablePromiseList';
 export * from './createConcurrentSafePromise';
 export * from './getNextActiveItemId';
 export * from './getNormalizedSources';
+export * from './getPluginSubmitPromise';
 export * from './getActiveItem';
 export * from './getAutocompleteElementId';
 export * from './isOrContainsNode';

package/dist/umd/index.development.js

@@ -1,4 +1,4 @@
-/*! @algolia/autocomplete-core 1.18.1 | MIT License | © Algolia, Inc. and contributors | https://github.com/algolia/autocomplete */
+/*! @algolia/autocomplete-core 1.19.0 | 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) :
@@ -101,6 +101,57 @@
   function _nonIterableSpread$2() {
     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 _createForOfIteratorHelper(o, allowArrayLike) {
+    var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"];
+    if (!it) {
+      if (Array.isArray(o) || (it = _unsupportedIterableToArray$4(o)) || allowArrayLike && o && typeof o.length === "number") {
+        if (it) o = it;
+        var i = 0;
+        var F = function () {};
+        return {
+          s: F,
+          n: function () {
+            if (i >= o.length) return {
+              done: true
+            };
+            return {
+              done: false,
+              value: o[i++]
+            };
+          },
+          e: function (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 () {
+        it = it.call(o);
+      },
+      n: function () {
+        var step = it.next();
+        normalCompletion = step.done;
+        return step;
+      },
+      e: function (e) {
+        didErr = true;
+        err = e;
+      },
+      f: function () {
+        try {
+          if (!normalCompletion && it.return != null) it.return();
+        } finally {
+          if (didErr) throw err;
+        }
+      }
+    };
+  }
   function _toPrimitive$2(input, hint) {
     if (typeof input !== "object" || input === null) return input;
     var prim = input[Symbol.toPrimitive];
@@ -291,7 +342,7 @@
     return undefined;
   }
 
-  var version = '1.18.1';
+  var version = '1.19.0';
 
   var userAgents = [{
     segment: 'autocomplete-core',
@@ -1090,6 +1141,9 @@
     };
   }
 
+  // Ensures multiple callers sync to the same promise.
+  var _hasWaitPromiseResolved = true;
+  var _waitPromise;
   function createCancelablePromiseList() {
     var list = [];
     return {
@@ -1108,6 +1162,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;
+        });
       }
     };
   }
@@ -1221,6 +1291,41 @@
     });
   }
 
+  /**
+   * 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.
@@ -1892,11 +1997,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;
@@ -2070,20 +2178,30 @@
     var getFormProps = function getFormProps(providedProps) {
       providedProps.inputElement;
         var rest = _objectWithoutProperties$1(providedProps, _excluded3);
+      var handleSubmit = function handleSubmit(event) {
+        var _providedProps$inputE;
+        props.onSubmit(_objectSpread2({
+          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 _objectSpread2({
         action: '',
         noValidate: true,
         role: 'search',
         onSubmit: function onSubmit(event) {
-          var _providedProps$inputE;
           event.preventDefault();
-          props.onSubmit(_objectSpread2({
-            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;