instantsearch.js 4.62.0 → 4.63.1

package/cjs/components/RefinementList/RefinementList.js

@@ -118,18 +118,18 @@ var RefinementList = /*#__PURE__*/function (_Component) {
         // if one special key is down
         return;
       }
-      if (!(originalEvent.target instanceof HTMLElement) || !(originalEvent.target.parentNode instanceof HTMLElement)) {
+      var parent = originalEvent.target;
+      if (parent === null || parent.parentNode === null) {
         return;
       }
-      if (isRefined && originalEvent.target.parentNode.querySelector('input[type="radio"]:checked')) {
+      if (isRefined && parent.parentNode.querySelector('input[type="radio"]:checked')) {
         // Prevent refinement for being reset if the user clicks on an already checked radio button
         return;
       }
-      if (originalEvent.target.tagName === 'INPUT') {
+      if (parent.tagName === 'INPUT') {
         _this.refine(facetValueToRefine);
         return;
       }
-      var parent = originalEvent.target;
       while (parent !== originalEvent.currentTarget) {
         if (parent.tagName === 'LABEL' && (parent.querySelector('input[type="checkbox"]') || parent.querySelector('input[type="radio"]'))) {
           return;

package/cjs/components/SearchBox/SearchBox.js

@@ -58,13 +58,15 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         refine = _this$props.refine,
         onChange = _this$props.onChange;
       var query = event.target.value;
-      if (searchAsYouType) {
-        refine(query);
+      if (event.type === 'compositionend' || !event.isComposing) {
+        if (searchAsYouType) {
+          refine(query);
+        }
+        _this.setState({
+          query: query
+        });
+        onChange(event);
       }
-      _this.setState({
-        query: query
-      });
-      onChange(event);
     });
     _defineProperty(_assertThisInitialized(_this), "onSubmit", function (event) {
       var _this$props2 = _this.props,
@@ -174,7 +176,11 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         ,
         spellCheck: "false",
         maxLength: 512,
-        onInput: this.onInput,
+        onInput: this.onInput
+        // see: https://github.com/preactjs/preact/issues/1978
+        // eslint-disable-next-line react/no-unknown-property
+        ,
+        oncompositionend: this.onInput,
         onBlur: this.onBlur,
         onFocus: this.onFocus,
         "aria-label": ariaLabel

package/cjs/connectors/search-box/connectSearchBox.js

@@ -70,7 +70,7 @@ var connectSearchBox = function connectSearchBox(renderFn) {
       },
       getWidgetRenderState: function getWidgetRenderState(_ref3) {
         var helper = _ref3.helper,
-          searchMetadata = _ref3.searchMetadata,
+          instantSearchInstance = _ref3.instantSearchInstance,
           state = _ref3.state;
         if (!_refine) {
           _refine = function _refine(query) {
@@ -87,7 +87,7 @@ var connectSearchBox = function connectSearchBox(renderFn) {
           refine: _refine,
           clear: _clear,
           widgetParams: widgetParams,
-          isSearchStalled: searchMetadata.isSearchStalled
+          isSearchStalled: instantSearchInstance.status === 'stalled'
         };
       },
       getWidgetUiState: function getWidgetUiState(uiState, _ref4) {

package/cjs/lib/routers/history.js

@@ -36,7 +36,8 @@ var BrowserHistory = /*#__PURE__*/function () {
       getLocation = _ref.getLocation,
       start = _ref.start,
       dispose = _ref.dispose,
-      push = _ref.push;
+      push = _ref.push,
+      cleanUrlOnDispose = _ref.cleanUrlOnDispose;
     _classCallCheck(this, BrowserHistory);
     _defineProperty(this, "$$type", 'ais.browser');
     /**
@@ -86,6 +87,7 @@ var BrowserHistory = /*#__PURE__*/function () {
     _defineProperty(this, "_start", void 0);
     _defineProperty(this, "_dispose", void 0);
     _defineProperty(this, "_push", void 0);
+    _defineProperty(this, "_cleanUrlOnDispose", void 0);
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
@@ -95,6 +97,13 @@ var BrowserHistory = /*#__PURE__*/function () {
     this._start = start;
     this._dispose = dispose;
     this._push = push;
+    this._cleanUrlOnDispose = typeof cleanUrlOnDispose === 'undefined' ? true : cleanUrlOnDispose;
+    if (process.env.NODE_ENV === 'development' && typeof cleanUrlOnDispose === 'undefined') {
+      // eslint-disable-next-line no-console
+      console.info("Starting from the next major version, InstantSearch will not clean up the URL from active refinements when it is disposed.\n\nWe recommend setting `cleanUrlOnDispose` to false to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to true.\n\nSee documentation: ".concat((0, _utils.createDocumentationLink)({
+        name: 'history-router'
+      }), "#widget-param-cleanurlondispose"));
+    }
     (0, _utils.safelyRunOnBrowser)(function (_ref2) {
       var window = _ref2.window;
       var title = _this.windowTitle && _this.windowTitle(_this.read());
@@ -222,7 +231,9 @@ var BrowserHistory = /*#__PURE__*/function () {
       if (this.writeTimer) {
         clearTimeout(this.writeTimer);
       }
-      this.write({});
+      if (this._cleanUrlOnDispose) {
+        this.write({});
+      }
     }
   }, {
     key: "start",
@@ -311,7 +322,8 @@ function historyRouter() {
     } : _ref7$getLocation,
     start = _ref7.start,
     dispose = _ref7.dispose,
-    push = _ref7.push;
+    push = _ref7.push,
+    cleanUrlOnDispose = _ref7.cleanUrlOnDispose;
   return new BrowserHistory({
     createURL: createURL,
     parseURL: parseURL,
@@ -320,6 +332,7 @@ function historyRouter() {
     getLocation: getLocation,
     start: start,
     dispose: dispose,
-    push: push
+    push: push,
+    cleanUrlOnDispose: cleanUrlOnDispose
   });
 }

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.62.0';
+var _default = '4.63.1';
 exports.default = _default;

package/cjs/middlewares/createInsightsMiddleware.js

@@ -22,7 +22,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 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; }
-var ALGOLIA_INSIGHTS_VERSION = '2.6.0';
+var ALGOLIA_INSIGHTS_VERSION = '2.13.0';
 var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
 function createInsightsMiddleware() {
   var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -106,7 +106,7 @@ function createInsightsMiddleware() {
       // set it later on.
       //
       // Otherwise, the `init` call might override it with anonymous user token.
-      userTokenBeforeInit = userToken;
+      userTokenBeforeInit = normalizeUserToken(userToken);
     });
 
     // Only `init` if the `insightsInitParams` option is passed or
@@ -162,13 +162,14 @@ function createInsightsMiddleware() {
         }
         var setUserTokenToSearch = function setUserTokenToSearch(userToken) {
           var immediate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-          if (!userToken) {
+          var normalizedUserToken = normalizeUserToken(userToken);
+          if (!normalizedUserToken) {
             return;
           }
           var existingToken = helper.state.userToken;
           function applyToken() {
             helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
-              userToken: userToken
+              userToken: normalizedUserToken
             }));
             if (existingToken && existingToken !== userToken) {
               instantSearchInstance.scheduleSearch();
@@ -265,4 +266,15 @@ function isModernInsightsClient(client) {
   /* eslint-enable @typescript-eslint/naming-convention */
 
   return v3 || v2_6 || v1_10;
+}
+
+/**
+ * While `search-insights` supports both string and number user tokens,
+ * the Search API only accepts strings. This function normalizes the user token.
+ */
+function normalizeUserToken(userToken) {
+  if (!userToken) {
+    return undefined;
+  }
+  return typeof userToken === 'number' ? userToken.toString() : userToken;
 }

package/dist/instantsearch.development.d.ts

@@ -486,11 +486,12 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     private _start?;
     private _dispose?;
     private _push?;
+    private _cleanUrlOnDispose;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
-    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, start, dispose, push, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, start, dispose, push, cleanUrlOnDispose, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -529,6 +530,13 @@ declare type BrowserHistoryArgs<TRouteState> = {
     start?: (onUpdate: () => void) => void;
     dispose?: () => void;
     push?: (url: string) => void;
+    /**
+     * Whether the URL should be cleaned up when the router is disposed.
+     * This can be useful when closing a modal containing InstantSearch, to
+     * remove active refinements from the URL.
+     * @default true
+     */
+    cleanUrlOnDispose?: boolean;
 };
 
 declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string, additionalData?: Record<string, any>) => string;
@@ -1813,7 +1821,7 @@ declare type HighlightProps_2 = Omit<HighlightProps_3, 'classNames'> & {
     classNames?: Partial<HighlightClassNames>;
 };
 
-declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, cleanUrlOnDispose, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
 declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
@@ -5328,9 +5336,7 @@ declare type ToggleRefinementTemplates = Partial<{
     /**
      * the text that describes the toggle action
      */
-    labelText: Template<ToggleRefinementValue & {
-        name: string;
-    }>;
+    labelText: Template<ToggleRefinementRenderState['value']>;
 }>;
 
 declare type ToggleRefinementValue = {

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.62.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.63.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -4566,7 +4566,7 @@
         },
         getWidgetRenderState: function getWidgetRenderState(_ref3) {
           var helper = _ref3.helper,
-            searchMetadata = _ref3.searchMetadata,
+            instantSearchInstance = _ref3.instantSearchInstance,
             state = _ref3.state;
           if (!_refine) {
             _refine = function _refine(query) {
@@ -4583,7 +4583,7 @@
             refine: _refine,
             clear: _clear,
             widgetParams: widgetParams,
-            isSearchStalled: searchMetadata.isSearchStalled
+            isSearchStalled: instantSearchInstance.status === 'stalled'
           };
         },
         getWidgetUiState: function getWidgetUiState(uiState, _ref4) {
@@ -10086,7 +10086,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.16.0';
+  var version = '3.16.1';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -12731,7 +12731,7 @@
     };
   }
 
-  var ALGOLIA_INSIGHTS_VERSION = '2.6.0';
+  var ALGOLIA_INSIGHTS_VERSION = '2.13.0';
   var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
   function createInsightsMiddleware() {
     var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -12815,7 +12815,7 @@
         // set it later on.
         //
         // Otherwise, the `init` call might override it with anonymous user token.
-        userTokenBeforeInit = userToken;
+        userTokenBeforeInit = normalizeUserToken(userToken);
       });
 
       // Only `init` if the `insightsInitParams` option is passed or
@@ -12871,13 +12871,14 @@
           }
           var setUserTokenToSearch = function setUserTokenToSearch(userToken) {
             var immediate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-            if (!userToken) {
+            var normalizedUserToken = normalizeUserToken(userToken);
+            if (!normalizedUserToken) {
               return;
             }
             var existingToken = helper.state.userToken;
             function applyToken() {
               helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread2(_objectSpread2({}, helper.state), {}, {
-                userToken: userToken
+                userToken: normalizedUserToken
               }));
               if (existingToken && existingToken !== userToken) {
                 instantSearchInstance.scheduleSearch();
@@ -12976,6 +12977,17 @@
     return v3 || v2_6 || v1_10;
   }
 
+  /**
+   * While `search-insights` supports both string and number user tokens,
+   * the Search API only accepts strings. This function normalizes the user token.
+   */
+  function normalizeUserToken(userToken) {
+    if (!userToken) {
+      return undefined;
+    }
+    return typeof userToken === 'number' ? userToken.toString() : userToken;
+  }
+
   function extractWidgetPayload(widgets, instantSearchInstance, payload) {
     var initOptions = createInitArgs(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
     widgets.forEach(function (widget) {
@@ -13899,7 +13911,8 @@
         getLocation = _ref.getLocation,
         start = _ref.start,
         dispose = _ref.dispose,
-        push = _ref.push;
+        push = _ref.push,
+        cleanUrlOnDispose = _ref.cleanUrlOnDispose;
       _classCallCheck(this, BrowserHistory);
       _defineProperty(this, "$$type", 'ais.browser');
       /**
@@ -13949,6 +13962,7 @@
       _defineProperty(this, "_start", void 0);
       _defineProperty(this, "_dispose", void 0);
       _defineProperty(this, "_push", void 0);
+      _defineProperty(this, "_cleanUrlOnDispose", void 0);
       this.windowTitle = windowTitle;
       this.writeTimer = undefined;
       this.writeDelay = writeDelay;
@@ -13958,6 +13972,13 @@
       this._start = start;
       this._dispose = dispose;
       this._push = push;
+      this._cleanUrlOnDispose = typeof cleanUrlOnDispose === 'undefined' ? true : cleanUrlOnDispose;
+      if ( typeof cleanUrlOnDispose === 'undefined') {
+        // eslint-disable-next-line no-console
+        console.info("Starting from the next major version, InstantSearch will not clean up the URL from active refinements when it is disposed.\n\nWe recommend setting `cleanUrlOnDispose` to false to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to true.\n\nSee documentation: ".concat(createDocumentationLink({
+          name: 'history-router'
+        }), "#widget-param-cleanurlondispose"));
+      }
       safelyRunOnBrowser(function (_ref2) {
         var window = _ref2.window;
         var title = _this.windowTitle && _this.windowTitle(_this.read());
@@ -14085,7 +14106,9 @@
         if (this.writeTimer) {
           clearTimeout(this.writeTimer);
         }
-        this.write({});
+        if (this._cleanUrlOnDispose) {
+          this.write({});
+        }
       }
     }, {
       key: "start",
@@ -14174,7 +14197,8 @@
       } : _ref7$getLocation,
       start = _ref7.start,
       dispose = _ref7.dispose,
-      push = _ref7.push;
+      push = _ref7.push,
+      cleanUrlOnDispose = _ref7.cleanUrlOnDispose;
     return new BrowserHistory({
       createURL: createURL,
       parseURL: parseURL,
@@ -14183,7 +14207,8 @@
       getLocation: getLocation,
       start: start,
       dispose: dispose,
-      push: push
+      push: push,
+      cleanUrlOnDispose: cleanUrlOnDispose
     });
   }
 
@@ -14822,7 +14847,7 @@
     };
   }
 
-  var version$1 = '4.62.0';
+  var version$1 = '4.63.1';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -18004,13 +18029,15 @@
           refine = _this$props.refine,
           onChange = _this$props.onChange;
         var query = event.target.value;
-        if (searchAsYouType) {
-          refine(query);
+        if (event.type === 'compositionend' || !event.isComposing) {
+          if (searchAsYouType) {
+            refine(query);
+          }
+          _this.setState({
+            query: query
+          });
+          onChange(event);
         }
-        _this.setState({
-          query: query
-        });
-        onChange(event);
       });
       _defineProperty(_assertThisInitialized(_this), "onSubmit", function (event) {
         var _this$props2 = _this.props,
@@ -18120,7 +18147,11 @@
           ,
           spellCheck: "false",
           maxLength: 512,
-          onInput: this.onInput,
+          onInput: this.onInput
+          // see: https://github.com/preactjs/preact/issues/1978
+          // eslint-disable-next-line react/no-unknown-property
+          ,
+          oncompositionend: this.onInput,
           onBlur: this.onBlur,
           onFocus: this.onFocus,
           "aria-label": ariaLabel
@@ -18281,18 +18312,18 @@
           // if one special key is down
           return;
         }
-        if (!(originalEvent.target instanceof HTMLElement) || !(originalEvent.target.parentNode instanceof HTMLElement)) {
+        var parent = originalEvent.target;
+        if (parent === null || parent.parentNode === null) {
           return;
         }
-        if (isRefined && originalEvent.target.parentNode.querySelector('input[type="radio"]:checked')) {
+        if (isRefined && parent.parentNode.querySelector('input[type="radio"]:checked')) {
           // Prevent refinement for being reset if the user clicks on an already checked radio button
           return;
         }
-        if (originalEvent.target.tagName === 'INPUT') {
+        if (parent.tagName === 'INPUT') {
           _this.refine(facetValueToRefine);
           return;
         }
-        var parent = originalEvent.target;
         while (parent !== originalEvent.currentTarget) {
           if (parent.tagName === 'LABEL' && (parent.querySelector('input[type="checkbox"]') || parent.querySelector('input[type="radio"]'))) {
             return;