instantsearch.js 4.62.0 → 4.63.1

package/es/components/RefinementList/RefinementList.js

@@ -112,18 +112,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/es/components/SearchBox/SearchBox.js

@@ -51,13 +51,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,
@@ -167,7 +169,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/es/connectors/search-box/connectSearchBox.js

@@ -64,7 +64,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) {
@@ -81,7 +81,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/es/lib/routers/history.d.ts

@@ -18,6 +18,13 @@ export 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 class BrowserHistory<TRouteState> implements Router<TRouteState> {
     $$type: string;
@@ -68,11 +75,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.
      */
@@ -101,5 +109,5 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     start(): void;
     private shouldWrite;
 }
-export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, cleanUrlOnDispose, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 export {};

package/es/lib/routers/history.js

@@ -6,7 +6,7 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 import qs from 'qs';
-import { safelyRunOnBrowser, warning } from "../utils/index.js";
+import { createDocumentationLink, safelyRunOnBrowser, warning } from "../utils/index.js";
 var setWindowTitle = function setWindowTitle(title) {
   if (title) {
     // This function is only executed on browsers so we can disable this check.
@@ -29,7 +29,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');
     /**
@@ -79,6 +80,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;
@@ -88,6 +90,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(createDocumentationLink({
+        name: 'history-router'
+      }), "#widget-param-cleanurlondispose"));
+    }
     safelyRunOnBrowser(function (_ref2) {
       var window = _ref2.window;
       var title = _this.windowTitle && _this.windowTitle(_this.read());
@@ -215,7 +224,9 @@ var BrowserHistory = /*#__PURE__*/function () {
       if (this.writeTimer) {
         clearTimeout(this.writeTimer);
       }
-      this.write({});
+      if (this._cleanUrlOnDispose) {
+        this.write({});
+      }
     }
   }, {
     key: "start",
@@ -304,7 +315,8 @@ export default 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,
@@ -313,6 +325,7 @@ export default function historyRouter() {
     getLocation: getLocation,
     start: start,
     dispose: dispose,
-    push: push
+    push: push,
+    cleanUrlOnDispose: cleanUrlOnDispose
   });
 }

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.62.0";
+declare const _default: "4.63.1";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.62.0';
+export default '4.63.1';

package/es/middlewares/createInsightsMiddleware.js

@@ -16,7 +16,7 @@ function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToAr
 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; }
 import { getInsightsAnonymousUserTokenInternal } from "../helpers/index.js";
 import { warning, noop, getAppIdAndApiKey, find, safelyRunOnBrowser } from "../lib/utils/index.js";
-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");
 export function createInsightsMiddleware() {
   var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -100,7 +100,7 @@ export 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
@@ -156,13 +156,14 @@ export 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();
@@ -259,4 +260,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/es/widgets/toggle-refinement/toggle-refinement.d.ts

@@ -1,5 +1,5 @@
 
-import type { ToggleRefinementConnectorParams, ToggleRefinementWidgetDescription, ToggleRefinementValue } from '../../connectors/toggle-refinement/connectToggleRefinement';
+import type { ToggleRefinementConnectorParams, ToggleRefinementWidgetDescription, ToggleRefinementRenderState } from '../../connectors/toggle-refinement/connectToggleRefinement';
 import type { Template, WidgetFactory } from '../../types';
 export type ToggleRefinementCSSClasses = Partial<{
     /**
@@ -23,9 +23,7 @@ export type ToggleRefinementTemplates = Partial<{
     /**
      * the text that describes the toggle action
      */
-    labelText: Template<ToggleRefinementValue & {
-        name: string;
-    }>;
+    labelText: Template<ToggleRefinementRenderState['value']>;
 }>;
 export type ToggleRefinementWidgetParams = {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.62.0",
+  "version": "4.63.1",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -33,12 +33,12 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "3.16.0",
+    "algoliasearch-helper": "3.16.1",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
     "preact": "^10.10.0",
     "qs": "^6.5.1 < 6.10",
-    "search-insights": "^2.6.0"
+    "search-insights": "^2.13.0"
   },
   "peerDependencies": {
     "algoliasearch": ">= 3.1 < 6"
@@ -49,21 +49,21 @@
     "build:cjs": "rm -rf cjs && BABEL_ENV=cjs babel --root-mode upward src --extensions '.js,.ts,.tsx' --out-dir cjs/ --ignore 'src/index.es.ts','**/__tests__','**/__mocks__' --quiet",
     "build:es": "rm -rf es && BABEL_ENV=es babel --root-mode upward src --extensions '.js,.ts,.tsx' --out-dir es/ --ignore 'src/index.es.ts','**/__tests__','**/__mocks__' --quiet && BABEL_ENV=es babel --root-mode upward src/index.es.ts --out-file es/index.js --quiet && echo '{\"type\":\"module\",\"sideEffects\":false}' > es/package.json",
     "build:types": "scripts/typescript/extract.js",
-    "storybook": "start-storybook --quiet --port 6006 --ci --static-dir .storybook/static",
-    "storybook:build": "build-storybook --quiet --output-dir ../../website/stories/js --static-dir .storybook/static",
+    "storybook": "NODE_OPTIONS=--openssl-legacy-provider start-storybook --quiet --port 6006 --ci --static-dir .storybook/static",
+    "storybook:build": "NODE_OPTIONS=--openssl-legacy-provider build-storybook --quiet --output-dir ../../website/stories/js --static-dir .storybook/static",
     "test:exports": "node test/module/is-es-module.mjs && node test/module/is-cjs-module.cjs",
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.31.0",
-    "@instantsearch/tests": "1.31.0",
-    "@instantsearch/testutils": "1.20.0",
+    "@instantsearch/mocks": "1.33.0",
+    "@instantsearch/tests": "1.33.0",
+    "@instantsearch/testutils": "1.22.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
     "places.js": "1.17.1",
     "scriptjs": "2.5.9",
-    "webpack": "4.41.5"
+    "webpack": "4.47.0"
   },
-  "gitHead": "967178e0e39302f1ff9552a42cfbdd9e06fd6864"
+  "gitHead": "4e99d1220b9c7872130f52bded4c1a84900bd0a3"
 }