react-instantsearch 7.0.1 → 7.0.3

package/README.md

@@ -1,6 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
 
 - [react-instantsearch](#react-instantsearch)
   - [Why](#why)
@@ -17,15 +17,15 @@
 
 React InstantSearch is an open-source React library that lets you create an instant search result experience using [Algolia][algolia-website]’s search API. It is part of the InstantSearch family:
 
-**React InstantSearch** | [InstantSearch.js][instantsearch.js-github] | [Angular InstantSearch][instantsearch-angular-github] | [Vue InstantSearch][instantsearch-vue-github] | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github]
+**React InstantSearch** | [InstantSearch.js][instantsearch-github] | [Angular InstantSearch][instantsearch-angular-github] | [Vue InstantSearch][instantsearch-github] | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github]
 
 ## Why
 
 You should be using React InstantSearch if you want to:
 
-* Design search experiences with best practices
-* Customize your components at will
-* Follow React principles
+- Design search experiences with best practices
+- Customize your components at will
+- Follow React principles
 
 Note: If you are working with React Native, or otherwise do not use the DOM, check out `react-instantsearch-core` instead.
 
@@ -55,10 +55,7 @@ const searchClient = algoliasearch(
 );
 
 const App = () => (
-  <InstantSearch
-    indexName="bestbuy"
-    searchClient={searchClient}
-  >
+  <InstantSearch indexName="bestbuy" searchClient={searchClient}>
     <SearchBox />
     <Hits />
   </InstantSearch>
@@ -66,7 +63,7 @@ const App = () => (
 ```
 
 <p align="center">
-  <a href="https://codesandbox.io/s/github/algolia/instantsearch.js/tree/master/examples/react/default-theme" title="Edit on CodeSandbox">
+  <a href="https://codesandbox.io/s/github/algolia/instantsearch/tree/master/examples/react/default-theme" title="Edit on CodeSandbox">
     <img alt="Edit on CodeSandbox" src="https://codesandbox.io/static/img/play-codesandbox.svg">
   </a>
 </p>
@@ -98,7 +95,7 @@ To start contributing to code, you need to:
 1.  [Clone the repository](https://help.github.com/articles/cloning-a-repository/)
 1.  Install the dependencies: `yarn`
 
-Please read [our contribution process](https://github.com/algolia/instantsearch.js/blob/master/CONTRIBUTING.md) to learn more.
+Please read [our contribution process](https://github.com/algolia/instantsearch/blob/master/CONTRIBUTING.md) to learn more.
 
 ## License
 
@@ -111,14 +108,13 @@ React InstantSearch is [MIT licensed](../../LICENSE).
 [doc-guides]: https://www.algolia.com/doc/guides/building-search-ui/going-further/server-side-rendering/react/
 [doc-playground]: https://codesandbox.io/s/github/algolia/instantsearch/tree/master/examples/react/default-theme
 [algolia-website]: https://www.algolia.com/
-[instantsearch.js-github]: https://github.com/algolia/instantsearch.js
+[instantsearch-github]: https://github.com/algolia/instantsearch
 [instantsearch-android-github]: https://github.com/algolia/instantsearch-android
 [instantsearch-ios-github]: https://github.com/algolia/instantsearch-ios
-[instantsearch-vue-github]: https://github.com/algolia/vue-instantsearch
 [instantsearch-angular-github]: https://github.com/algolia/angular-instantsearch
-[contributing-bugreport]: https://github.com/algolia/instantsearch.js/issues/new?template=BUG_REPORT.yml&labels=triage,Library%3A%20React+InstantSearch
-[contributing-featurerequest]: https://github.com/algolia/instantsearch.js/discussions/new?category=ideas&labels=triage,Library%3A%20React+InstantSearch&title=Feature%20request%3A%20
-[contributing-newissue]: https://github.com/algolia/instantsearch.js/issues/new?labels=triage,Library%3A%20React+InstantSearch
-[contributing-label-easy]: https://github.com/algolia/instantsearch.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+Easy%22+label%3A%22Library%3A%20React+InstantSearch%22
-[contributing-label-bug]: https://github.com/algolia/instantsearch.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug%22+label%3A%22Library%3A%20React+InstantSearch%22
-[contributing-label-chore]: https://github.com/algolia/instantsearch.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Chore%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-bugreport]: https://github.com/algolia/instantsearch/issues/new?template=BUG_REPORT.yml&labels=triage,Library%3A%20React+InstantSearch
+[contributing-featurerequest]: https://github.com/algolia/instantsearch/discussions/new?category=ideas&labels=triage,Library%3A%20React+InstantSearch&title=Feature%20request%3A%20
+[contributing-newissue]: https://github.com/algolia/instantsearch/issues/new?labels=triage,Library%3A%20React+InstantSearch
+[contributing-label-easy]: https://github.com/algolia/instantsearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+Easy%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-label-bug]: https://github.com/algolia/instantsearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-label-chore]: https://github.com/algolia/instantsearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Chore%22+label%3A%22Library%3A%20React+InstantSearch%22

package/dist/cjs/ui/CurrentRefinements.js

@@ -5,8 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.CurrentRefinements = CurrentRefinements;
 var _react = _interopRequireDefault(require("react"));
-var _cx = require("./lib/cx");
-var _isModifierClick = require("./lib/isModifierClick");
+var _lib = require("./lib");
 var _excluded = ["classNames", "items", "onRemove", "hasRefinements"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
@@ -23,30 +22,31 @@ function CurrentRefinements(_ref) {
     hasRefinements = _ref$hasRefinements === void 0 ? false : _ref$hasRefinements,
     props = _objectWithoutProperties(_ref, _excluded);
   return /*#__PURE__*/_react.default.createElement("div", _extends({}, props, {
-    className: (0, _cx.cx)('ais-CurrentRefinements', classNames.root, !hasRefinements && (0, _cx.cx)('ais-CurrentRefinements--noRefinement', classNames.noRefinementRoot), props.className)
+    className: (0, _lib.cx)('ais-CurrentRefinements', classNames.root, !hasRefinements && (0, _lib.cx)('ais-CurrentRefinements--noRefinement', classNames.noRefinementRoot), props.className)
   }), /*#__PURE__*/_react.default.createElement("ul", {
-    className: (0, _cx.cx)('ais-CurrentRefinements-list', classNames.list, !hasRefinements && (0, _cx.cx)('ais-CurrentRefinements-list--noRefinement', classNames.noRefinementList))
+    className: (0, _lib.cx)('ais-CurrentRefinements-list', classNames.list, /* @MAJOR remove to ensure conformity with InstantSearch.css specs */
+    !hasRefinements && (0, _lib.cx)('ais-CurrentRefinements-list--noRefinement', classNames.noRefinementList))
   }, items.map(function (item) {
     return /*#__PURE__*/_react.default.createElement("li", {
       key: [item.indexName, item.label].join('/'),
-      className: (0, _cx.cx)('ais-CurrentRefinements-item', classNames.item)
+      className: (0, _lib.cx)('ais-CurrentRefinements-item', classNames.item)
     }, /*#__PURE__*/_react.default.createElement("span", {
-      className: (0, _cx.cx)('ais-CurrentRefinements-label', classNames.label)
-    }, item.label, ":"), item.refinements.map(function (refinement) {
+      className: (0, _lib.cx)('ais-CurrentRefinements-label', classNames.label)
+    }, (0, _lib.capitalize)(item.label), ":", ' '), item.refinements.map(function (refinement) {
       return /*#__PURE__*/_react.default.createElement("span", {
         key: refinement.label,
-        className: (0, _cx.cx)('ais-CurrentRefinements-category', classNames.category)
+        className: (0, _lib.cx)('ais-CurrentRefinements-category', classNames.category)
       }, /*#__PURE__*/_react.default.createElement("span", {
-        className: (0, _cx.cx)('ais-CurrentRefinements-categoryLabel', classNames.categoryLabel)
+        className: (0, _lib.cx)('ais-CurrentRefinements-categoryLabel', classNames.categoryLabel)
       }, refinement.label), /*#__PURE__*/_react.default.createElement("button", {
         type: "button",
         onClick: function onClick(event) {
-          if ((0, _isModifierClick.isModifierClick)(event)) {
+          if ((0, _lib.isModifierClick)(event)) {
             return;
           }
           onRemove(refinement);
         },
-        className: (0, _cx.cx)('ais-CurrentRefinements-delete', classNames.delete)
+        className: (0, _lib.cx)('ais-CurrentRefinements-delete', classNames.delete)
       }, "\u2715"));
     }));
   })));

package/dist/cjs/ui/lib/capitalize.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.capitalize = capitalize;
+function capitalize(text) {
+  return text.toString().charAt(0).toUpperCase() + text.toString().slice(1);
+}

package/dist/cjs/ui/lib/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _capitalize = require("./capitalize");
+Object.keys(_capitalize).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _capitalize[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _capitalize[key];
+    }
+  });
+});
+var _cx = require("./cx");
+Object.keys(_cx).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _cx[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _cx[key];
+    }
+  });
+});
+var _isModifierClick = require("./isModifierClick");
+Object.keys(_isModifierClick).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _isModifierClick[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _isModifierClick[key];
+    }
+  });
+});

package/dist/es/ui/CurrentRefinements.js

@@ -3,8 +3,7 @@ function _extends() { _extends = Object.assign ? Object.assign.bind() : function
 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 React from 'react';
-import { cx } from "./lib/cx.js";
-import { isModifierClick } from "./lib/isModifierClick.js";
+import { capitalize, cx, isModifierClick } from "./lib/index.js";
 export function CurrentRefinements(_ref) {
   var _ref$classNames = _ref.classNames,
     classNames = _ref$classNames === void 0 ? {} : _ref$classNames,
@@ -18,14 +17,15 @@ export function CurrentRefinements(_ref) {
   return /*#__PURE__*/React.createElement("div", _extends({}, props, {
     className: cx('ais-CurrentRefinements', classNames.root, !hasRefinements && cx('ais-CurrentRefinements--noRefinement', classNames.noRefinementRoot), props.className)
   }), /*#__PURE__*/React.createElement("ul", {
-    className: cx('ais-CurrentRefinements-list', classNames.list, !hasRefinements && cx('ais-CurrentRefinements-list--noRefinement', classNames.noRefinementList))
+    className: cx('ais-CurrentRefinements-list', classNames.list, /* @MAJOR remove to ensure conformity with InstantSearch.css specs */
+    !hasRefinements && cx('ais-CurrentRefinements-list--noRefinement', classNames.noRefinementList))
   }, items.map(function (item) {
     return /*#__PURE__*/React.createElement("li", {
       key: [item.indexName, item.label].join('/'),
       className: cx('ais-CurrentRefinements-item', classNames.item)
     }, /*#__PURE__*/React.createElement("span", {
       className: cx('ais-CurrentRefinements-label', classNames.label)
-    }, item.label, ":"), item.refinements.map(function (refinement) {
+    }, capitalize(item.label), ":", ' '), item.refinements.map(function (refinement) {
       return /*#__PURE__*/React.createElement("span", {
         key: refinement.label,
         className: cx('ais-CurrentRefinements-category', classNames.category)

package/dist/es/ui/lib/capitalize.d.ts

@@ -0,0 +1 @@
+export declare function capitalize(text: string): string;

package/dist/es/ui/lib/capitalize.js

@@ -0,0 +1,3 @@
+export function capitalize(text) {
+  return text.toString().charAt(0).toUpperCase() + text.toString().slice(1);
+}

package/dist/es/ui/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './capitalize';
+export * from './cx';
+export * from './isModifierClick';

package/dist/es/ui/lib/index.js

@@ -0,0 +1,3 @@
+export * from "./capitalize.js";
+export * from "./cx.js";
+export * from "./isModifierClick.js";

package/dist/umd/ReactInstantSearch.js

@@ -1,4 +1,4 @@
-/*! React InstantSearch UNRELEASED | © Algolia, inc. | https://github.com/algolia/instantsearch.js */
+/*! React InstantSearch UNRELEASED | © Algolia, inc. | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
   typeof define === 'function' && define.amd ? define(['exports', 'react'], factory) :
@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.0.1';
+  var version = '7.0.3';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -4327,7 +4327,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version$1 = '3.14.0';
+  var version$1 = '3.14.1';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -8522,7 +8522,7 @@
 
           // We get the widget render state by providing the same parameters as
           // InstantSearch provides to the widget's `render` method.
-          // See https://github.com/algolia/instantsearch.js/blob/019cd18d0de6dd320284aa4890541b7fe2198c65/src/widgets/index/index.ts#L604-L617
+          // See https://github.com/algolia/instantsearch/blob/019cd18d0de6dd320284aa4890541b7fe2198c65/src/widgets/index/index.ts#L604-L617
           var _widget$getWidgetRend = widget.getWidgetRenderState({
               helper: helper,
               parent: parentIndex,
@@ -9369,7 +9369,7 @@
         // configuration step. This is mainly for backward compatibility with custom
         // widgets. When the subscription happens before the `init` step, the (static)
         // configuration of the widget is pushed in the URL. That's what we want to avoid.
-        // https://github.com/algolia/instantsearch.js/pull/994/commits/4a672ae3fd78809e213de0368549ef12e9dc9454
+        // https://github.com/algolia/instantsearch/pull/994/commits/4a672ae3fd78809e213de0368549ef12e9dc9454
         helper.on('change', function (event) {
           var state = event.state;
           var _uiState = event._uiState;
@@ -11271,7 +11271,7 @@
        *
        * It always generates the full URL, not a relative one.
        * This allows to handle cases like using a <base href>.
-       * See: https://github.com/algolia/instantsearch.js/issues/790
+       * See: https://github.com/algolia/instantsearch/issues/790
        */
     }, {
       key: "createURL",
@@ -11760,7 +11760,7 @@
     };
   }
 
-  var version$3 = '4.56.9';
+  var version$3 = '4.56.11';
 
   function _typeof$n(obj) {
     "@babel/helpers - typeof";
@@ -12350,7 +12350,7 @@
       /**
        * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
        * if you find an issue with it, please
-       * [open an issue](https://github.com/algolia/instantsearch.js/issues/new?title=Problem%20with%20dispose).
+       * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
        * @return {undefined} This method does not return anything
        */
     }, {
@@ -12498,7 +12498,7 @@
     if (searchRef.current === null) {
       // We don't use the `instantsearch()` function because it comes with other
       // top-level APIs that we don't need.
-      // See https://github.com/algolia/instantsearch.js/blob/5b529f43d8acc680f85837eaaa41f7fd03a3f833/src/index.es.ts#L63-L86
+      // See https://github.com/algolia/instantsearch/blob/5b529f43d8acc680f85837eaaa41f7fd03a3f833/src/index.es.ts#L63-L86
       var search = new InstantSearch(props);
       search._schedule = function _schedule(cb) {
         search._schedule.queue.push(cb);
@@ -17865,7 +17865,7 @@
 
         // Results can be `null` when the first search is stalled.
         // In this case, we skip the update.
-        // See: https://github.com/algolia/instantsearch.js/blob/20996c7a159988c58e00ff24d2d2dc98af8b980f/src/widgets/index/index.ts#L652-L657
+        // See: https://github.com/algolia/instantsearch/blob/20996c7a159988c58e00ff24d2d2dc98af8b980f/src/widgets/index/index.ts#L652-L657
         if (results !== null) {
           setSearchResults({
             results: results,
@@ -18107,13 +18107,18 @@
     var initialResults = {};
     walkIndex(rootIndex, function (widget) {
       var searchResults = widget.getResults();
-      initialResults[widget.getIndexId()] = {
-        // We convert the Helper state to a plain object to pass parsable data
-        // structures from server to client.
-        state: _objectSpread$z({}, searchResults._state),
-        results: searchResults._rawResults
-      };
+      if (searchResults) {
+        initialResults[widget.getIndexId()] = {
+          // We convert the Helper state to a plain object to pass parsable data
+          // structures from server to client.
+          state: _objectSpread$z({}, searchResults._state),
+          results: searchResults._rawResults
+        };
+      }
     });
+    if (Object.keys(initialResults).length === 0) {
+      throw new Error('The root index does not have any results. Make sure you have at least one widget that provides results.');
+    }
     return initialResults;
   }
 
@@ -18475,6 +18480,10 @@
     return /*#__PURE__*/React__default.createElement(ClearRefinements, _extends$1({}, props, uiProps));
   }
 
+  function capitalize(text) {
+    return text.toString().charAt(0).toUpperCase() + text.toString().slice(1);
+  }
+
   var _excluded$g = ["classNames", "items", "onRemove", "hasRefinements"];
   function CurrentRefinements(_ref) {
     var _ref$classNames = _ref.classNames,
@@ -18489,14 +18498,15 @@
     return /*#__PURE__*/React__default.createElement("div", _extends$1({}, props, {
       className: cx('ais-CurrentRefinements', classNames.root, !hasRefinements && cx('ais-CurrentRefinements--noRefinement', classNames.noRefinementRoot), props.className)
     }), /*#__PURE__*/React__default.createElement("ul", {
-      className: cx('ais-CurrentRefinements-list', classNames.list, !hasRefinements && cx('ais-CurrentRefinements-list--noRefinement', classNames.noRefinementList))
+      className: cx('ais-CurrentRefinements-list', classNames.list, /* @MAJOR remove to ensure conformity with InstantSearch.css specs */
+      !hasRefinements && cx('ais-CurrentRefinements-list--noRefinement', classNames.noRefinementList))
     }, items.map(function (item) {
       return /*#__PURE__*/React__default.createElement("li", {
         key: [item.indexName, item.label].join('/'),
         className: cx('ais-CurrentRefinements-item', classNames.item)
       }, /*#__PURE__*/React__default.createElement("span", {
         className: cx('ais-CurrentRefinements-label', classNames.label)
-      }, item.label, ":"), item.refinements.map(function (refinement) {
+      }, capitalize(item.label), ":", ' '), item.refinements.map(function (refinement) {
         return /*#__PURE__*/React__default.createElement("span", {
           key: refinement.label,
           className: cx('ais-CurrentRefinements-category', classNames.category)