instantsearch.js 4.56.7 → 4.56.9

package/README.md

@@ -67,7 +67,11 @@ search.addWidgets([
   instantsearch.widgets.hits({
     container: '#products',
     templates: {
-      item: '{{#helpers.highlight}}{ "attribute": "name" }{{/helpers.highlight}}',
+      item: (hit, { html, components }) =>
+        html`
+          <h3>${components.Highlight({ attribute: 'name', hit })}</h3>
+          <p>${components.Snippet({ attribute: 'description', hit })}</p>
+        `,
     },
   }),
 
@@ -102,7 +106,7 @@ yarn add instantsearch.js algoliasearch
 
 To use InstantSearch.js in a TypeScript environment, depending on your [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript) version, you need to import different types.
 
->You still need to import these types even if you don't use InstantSearch.js with [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript).
+> You still need to import these types even if you don't use InstantSearch.js with [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript).
 
 #### `algoliasearch` v4.x
 
@@ -118,7 +122,7 @@ yarn add algoliasearch@4 @algolia/client-search
 yarn add @types/algoliasearch@3
 ```
 
->v3.x is deprecated and will soon no longer be supported.
+> v3.x is deprecated and will soon no longer be supported.
 
 ## Documentation
 
@@ -126,8 +130,8 @@ The documentation is available on the [Algolia website](https://www.algolia.com/
 
 ## Demos
 
-| E-commerce                                                                                                                                                                                                                   | Media                                                                                                                                                                                                         | Travel                                                                                                                                                                                                              |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| E-commerce | Media | Travel |
+| --- | --- | --- |
 | <a href="https://instantsearchjs.netlify.com/examples/e-commerce/"><img src="https://www.algolia.com/doc/assets/images/build-search-ui/demos/e-commerce-2c7ed6b6.png" width="250" alt="E-commerce demo preview"></a> | <a href="https://instantsearchjs.netlify.com/examples/media/"><img src="https://www.algolia.com/doc/assets/images/build-search-ui/demos/media-articles-abc153ab.png" width="250" alt="Media demo preview"></a> | <a href="https://instantsearchjs.netlify.com/examples/tourism/"><img src="https://instantsearchjs.netlify.com/examples/tourism/capture.png" width="250" alt="Tourism demo preview"></a> |
 
 See more demos [on the website](https://www.algolia.com/doc/guides/building-search-ui/resources/demos/js/).

package/cjs/components/RefinementList/RefinementList.js

@@ -31,6 +31,8 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 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); }
+// CSS types
+
 var defaultProps = {
   cssClasses: {},
   depth: 0
@@ -92,6 +94,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/cjs/components/Slider/Rheostat.js

@@ -19,7 +19,11 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 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); }
-function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); } /**
+                                                                                                                                                                                                                                                                                                                                                     * This is a fork of Rheostat for Preact X.
+                                                                                                                                                                                                                                                                                                                                                     *
+                                                                                                                                                                                                                                                                                                                                                     * @see https://github.com/airbnb/rheostat
+                                                                                                                                                                                                                                                                                                                                                     */
 var KEYS = {
   DOWN: 40,
   END: 35,
@@ -394,6 +398,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/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -81,7 +81,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/cjs/connectors/configure/connectConfigure.js

@@ -13,6 +13,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 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); }
+/**
+ * Refine the given search parameters.
+ */
+
 var withUsage = (0, _utils.createDocumentationMessageGenerator)({
   name: 'configure',
   connector: true

package/cjs/connectors/hits/connectHitsWithInsights.js

@@ -7,6 +7,11 @@ exports.default = void 0;
 var _insights = require("../../lib/insights");
 var _connectHits = _interopRequireDefault(require("./connectHits"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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 = (0, _insights.withInsights)(_connectHits.default);
 var _default = connectHitsWithInsights;
 exports.default = _default;

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

@@ -7,6 +7,11 @@ exports.default = void 0;
 var _insights = require("../../lib/insights");
 var _connectInfiniteHits = _interopRequireDefault(require("./connectInfiniteHits"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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 = (0, _insights.withInsights)(_connectInfiniteHits.default);
 var _default = connectInfiniteHitsWithInsights;
 exports.default = _default;

package/cjs/connectors/pagination/connectPagination.js

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

package/cjs/connectors/range/connectRange.js

@@ -25,6 +25,9 @@ var withUsage = (0, _utils.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/cjs/connectors/search-box/connectSearchBox.js

@@ -15,6 +15,16 @@ var withUsage = (0, _utils.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/cjs/lib/InstantSearch.js

@@ -40,6 +40,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.
@@ -73,7 +76,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", (0, _utils.defer)(function () {
       if (_this.started) {
@@ -193,15 +203,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/cjs/lib/routers/history.js

@@ -22,48 +22,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).
@@ -81,15 +39,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/cjs/lib/version.js

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

package/cjs/widgets/configure/configure.js

@@ -13,6 +13,11 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 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); }
+/**
+ * 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/cjs/widgets/geo-search/createHTMLMarker.js

@@ -18,7 +18,7 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 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); }
+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); } /* global google EventListener */
 var createHTMLMarker = function createHTMLMarker(googleReference) {
   var HTMLMarker = /*#__PURE__*/function (_googleReference$maps) {
     _inherits(HTMLMarker, _googleReference$maps);

package/cjs/widgets/geo-search/geo-search.js

@@ -16,7 +16,8 @@ var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
 var _GeoSearchRenderer = _interopRequireDefault(require("./GeoSearchRenderer"));
 var _excluded = ["initialZoom", "initialPosition", "templates", "cssClasses", "builtInMarker", "customHTMLMarker", "enableRefine", "enableClearMapRefinement", "enableRefineControl", "container", "googleReference"],
   _excluded2 = ["item"],
-  _excluded3 = ["item"];
+  _excluded3 = ["item"]; // global for TypeScript alone
+/* global google */
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }

package/cjs/widgets/places/places.js

@@ -16,9 +16,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.