instantsearch.js 4.56.8 → 4.56.9

package/es/components/RefinementList/RefinementList.js

@@ -24,6 +24,9 @@ import { isSpecialClick, isEqual } from "../../lib/utils/index.js";
 import SearchBox from "../SearchBox/SearchBox.js";
 import Template from "../Template/Template.js";
 import RefinementListItem from "./RefinementListItem.js";
+
+// CSS types
+
 var defaultProps = {
   cssClasses: {},
   depth: 0
@@ -85,6 +88,21 @@ var RefinementList = /*#__PURE__*/function (_Component) {
         templateProps: _this.props.templateProps
       });
     });
+    // Click events on DOM tree like LABEL > INPUT will result in two click events
+    // instead of one.
+    // No matter the framework, see https://www.google.com/search?q=click+label+twice
+    //
+    // Thus making it hard to distinguish activation from deactivation because both click events
+    // are very close. Debounce is a solution but hacky.
+    //
+    // So the code here checks if the click was done on or in a LABEL. If this LABEL
+    // has a checkbox inside, we ignore the first click event because we will get another one.
+    //
+    // We also check if the click was done inside a link and then e.preventDefault() because we already
+    // handle the url
+    //
+    // Finally, we always stop propagation of the event to avoid multiple levels RefinementLists to fail: click
+    // on child would click on parent also
     _defineProperty(_assertThisInitialized(_this), "handleItemClick", function (_ref) {
       var facetValueToRefine = _ref.facetValueToRefine,
         isRefined = _ref.isRefined,

package/es/components/Slider/Rheostat.js

@@ -392,6 +392,8 @@ var Rheostat = /*#__PURE__*/function (_Component) {
       }
       killEvent(ev);
     });
+    // Make sure the proposed position respects the bounds and
+    // does not collide with other handles too much.
     _defineProperty(_assertThisInitialized(_this), "validatePosition", function (idx, proposedPosition) {
       var _this$state4 = _this.state,
         handlePos = _this$state4.handlePos,

package/es/connectors/breadcrumb/connectBreadcrumb.js

@@ -75,7 +75,7 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
         function getItems() {
           // The hierarchicalFacets condition is required for flavors
           // that render immediately with empty results, without relying
-          // on init() (like React InstantSearch Hooks).
+          // on init() (like React InstantSearch).
           if (!results || state.hierarchicalFacets.length === 0) {
             return [];
           }

package/es/connectors/configure/connectConfigure.js

@@ -6,6 +6,11 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 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 algoliasearchHelper from 'algoliasearch-helper';
 import { createDocumentationMessageGenerator, isPlainObject, mergeSearchParameters, noop } from "../../lib/utils/index.js";
+
+/**
+ * Refine the given search parameters.
+ */
+
 var withUsage = createDocumentationMessageGenerator({
   name: 'configure',
   connector: true

package/es/connectors/hits/connectHitsWithInsights.js

@@ -1,4 +1,10 @@
 import { withInsights } from "../../lib/insights/index.js";
 import connectHits from "./connectHits.js";
+
+/**
+ * Due to https://github.com/microsoft/web-build-tools/issues/1050, we need
+ * Connector<...> imported in this file, even though it is only used implicitly.
+ * This _uses_ Connector<...> so it is not accidentally removed by someone.
+ */ // eslint-disable-next-line @typescript-eslint/no-unused-vars
 var connectHitsWithInsights = withInsights(connectHits);
 export default connectHitsWithInsights;

package/es/connectors/infinite-hits/connectInfiniteHitsWithInsights.js

@@ -1,4 +1,10 @@
 import { withInsights } from "../../lib/insights/index.js";
 import connectInfiniteHits from "./connectInfiniteHits.js";
+
+/**
+ * Due to https://github.com/microsoft/web-build-tools/issues/1050, we need
+ * Connector<...> imported in this file, even though it is only used implicitly.
+ * This _uses_ Connector<...> so it is not accidentally removed by someone.
+ */ // eslint-disable-next-line @typescript-eslint/no-unused-vars
 var connectInfiniteHitsWithInsights = withInsights(connectInfiniteHits);
 export default connectInfiniteHitsWithInsights;

package/es/connectors/pagination/connectPagination.js

@@ -84,7 +84,7 @@ var connectPagination = function connectPagination(renderFn) {
           connectorState.createURL = function (page) {
             return createURL(function (uiState) {
               return _objectSpread(_objectSpread({}, uiState), {}, {
-                page: page
+                page: page + 1
               });
             });
           };

package/es/connectors/range/connectRange.js

@@ -19,6 +19,9 @@ var withUsage = createDocumentationMessageGenerator({
   connector: true
 });
 var $$type = 'ais.range';
+
+// @MAJOR: potentially we should consolidate these types
+
 function toPrecision(_ref) {
   var min = _ref.min,
     max = _ref.max,

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

@@ -9,6 +9,16 @@ var withUsage = createDocumentationMessageGenerator({
   name: 'search-box',
   connector: true
 });
+
+/**
+ * @typedef {Object} CustomSearchBoxWidgetParams
+ * @property {function(string, function(string))} [queryHook = undefined] A function that will be called every time
+ * a new value for the query is set. The first parameter is the query and the second is a
+ * function to actually trigger the search. The function takes the query as the parameter.
+ *
+ * This queryHook can be used to debounce the number of searches done from the searchBox.
+ */
+
 var defaultQueryHook = function defaultQueryHook(query, hook) {
   return hook(query);
 };

package/es/lib/InstantSearch.js

@@ -33,6 +33,9 @@ function defaultCreateURL() {
 // this purposely breaks typescript's type inference to ensure it's not used
 // as it's used for a default parameter for example
 // source: https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546
+/**
+ * Global options for an InstantSearch instance.
+ */
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -66,7 +69,14 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _defineProperty(_assertThisInitialized(_this), "_mainHelperSearch", void 0);
     _defineProperty(_assertThisInitialized(_this), "middleware", []);
     _defineProperty(_assertThisInitialized(_this), "sendEventToInsights", void 0);
+    /**
+     * The status of the search. Can be "idle", "loading", "stalled", or "error".
+     */
     _defineProperty(_assertThisInitialized(_this), "status", 'idle');
+    /**
+     * The last returned error from the Search API.
+     * The error gets cleared when the next valid search response is rendered.
+     */
     _defineProperty(_assertThisInitialized(_this), "error", undefined);
     _defineProperty(_assertThisInitialized(_this), "scheduleSearch", defer(function () {
       if (_this.started) {
@@ -186,15 +196,6 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
   _createClass(InstantSearch, [{
     key: "_isSearchStalled",
     get:
-    /**
-     * The status of the search. Can be "idle", "loading", "stalled", or "error".
-     */
-
-    /**
-     * The last returned error from the Search API.
-     * The error gets cleared when the next valid search response is rendered.
-     */
-
     /**
      * @deprecated use `status === 'stalled'` instead
      */

package/es/lib/routers/history.js

@@ -15,48 +15,6 @@ var setWindowTitle = function setWindowTitle(title) {
   }
 };
 var BrowserHistory = /*#__PURE__*/function () {
-  /**
-   * Transforms a UI state into a title for the page.
-   */
-
-  /**
-   * Time in milliseconds before performing a write in the history.
-   * It prevents from adding too many entries in the history and
-   * makes the back button more usable.
-   *
-   * @default 400
-   */
-
-  /**
-   * Creates a full URL based on the route state.
-   * The storage adaptor maps all syncable keys to the query string of the URL.
-   */
-
-  /**
-   * Parses the URL into a route state.
-   * It should be symmetrical to `createURL`.
-   */
-
-  /**
-   * Returns the location to store in the history.
-   * @default () => window.location
-   */
-
-  /**
-   * Indicates if last action was back/forward in the browser.
-   */
-
-  /**
-   * Indicates whether the history router is disposed or not.
-   */
-
-  /**
-   * Indicates the window.history.length before the last call to
-   * window.history.pushState (called in `write`).
-   * It allows to determine if a `pushState` has been triggered elsewhere,
-   * and thus to prevent the `write` method from calling `pushState`.
-   */
-
   /**
    * Initializes a new storage provider that syncs the search state to the URL
    * using web APIs (`window.location.pushState` and `onpopstate` event).
@@ -74,15 +32,49 @@ var BrowserHistory = /*#__PURE__*/function () {
       push = _ref.push;
     _classCallCheck(this, BrowserHistory);
     _defineProperty(this, "$$type", 'ais.browser');
+    /**
+     * Transforms a UI state into a title for the page.
+     */
     _defineProperty(this, "windowTitle", void 0);
+    /**
+     * Time in milliseconds before performing a write in the history.
+     * It prevents from adding too many entries in the history and
+     * makes the back button more usable.
+     *
+     * @default 400
+     */
     _defineProperty(this, "writeDelay", void 0);
+    /**
+     * Creates a full URL based on the route state.
+     * The storage adaptor maps all syncable keys to the query string of the URL.
+     */
     _defineProperty(this, "_createURL", void 0);
+    /**
+     * Parses the URL into a route state.
+     * It should be symmetrical to `createURL`.
+     */
     _defineProperty(this, "parseURL", void 0);
+    /**
+     * Returns the location to store in the history.
+     * @default () => window.location
+     */
     _defineProperty(this, "getLocation", void 0);
     _defineProperty(this, "writeTimer", void 0);
     _defineProperty(this, "_onPopState", void 0);
+    /**
+     * Indicates if last action was back/forward in the browser.
+     */
     _defineProperty(this, "inPopState", false);
+    /**
+     * Indicates whether the history router is disposed or not.
+     */
     _defineProperty(this, "isDisposed", false);
+    /**
+     * Indicates the window.history.length before the last call to
+     * window.history.pushState (called in `write`).
+     * It allows to determine if a `pushState` has been triggered elsewhere,
+     * and thus to prevent the `write` method from calling `pushState`.
+     */
     _defineProperty(this, "latestAcknowledgedHistory", 0);
     _defineProperty(this, "_start", void 0);
     _defineProperty(this, "_dispose", void 0);

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.56.8";
+declare const _default: "4.56.9";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.56.8';
+export default '4.56.9';

package/es/widgets/configure/configure.js

@@ -6,6 +6,12 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 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 connectConfigure from "../../connectors/configure/connectConfigure.js";
 import { noop } from "../../lib/utils/index.js";
+
+/**
+ * A list of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/)
+ * to enable when the widget mounts.
+ */
+
 var configure = function configure(widgetParams) {
   // This is a renderless widget that falls back to the connector's
   // noop render and unmount functions.

package/es/widgets/places/places.js

@@ -10,9 +10,7 @@ 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; }
 /* Places.js is an optional dependency, no error should be reported if the package is missing */
 /** @ts-ignore */
-
 // using the type like this requires only one ts-ignore
-
 /**
  * This widget sets the geolocation value for the search based on the selected
  * result in the Algolia Places autocomplete.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.56.8",
+  "version": "4.56.9",
   "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",
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.21.0",
-    "@instantsearch/tests": "1.21.0",
-    "@instantsearch/testutils": "1.10.0",
+    "@instantsearch/mocks": "1.23.0",
+    "@instantsearch/tests": "1.23.0",
+    "@instantsearch/testutils": "1.12.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -65,5 +65,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.41.5"
   },
-  "gitHead": "f4acbc0c1106a4fd7c7ad95a3e02de4fdac1ad27"
+  "gitHead": "94deb1ad0715410c61f4aa285a78a36ccf367fd7"
 }