instantsearch.js 4.52.0 → 4.54.0

package/README.md

@@ -10,11 +10,6 @@
 
 ---
 
-[![Version][version-svg]][package-url]
-[![License][license-image]][license-url]
-[![Build Status][ci-svg]][ci-url]
-[![Pull reminders][pull-reminders-svg]][pull-reminders-url]
-
 InstantSearch.js is a vanilla JavaScript library that lets you create an instant-search result experience using [Algolia][algolia-website]’s search API. It is part of the InstantSearch family:
 
 **InstantSearch.js** | [React InstantSearch][react-instantsearch-github] | [Vue InstantSearch][vue-instantsearch-github] | [Angular InstantSearch][instantsearch-angular-github] | [React InstantSearch Native][react-instantsearch-github] | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github]
@@ -176,19 +171,9 @@ Please read [our contribution process](https://github.com/algolia/instantsearch.
 
 InstantSearch.js is [MIT licensed][license-url].
 
-<!-- Badges -->
-
-[version-svg]: https://img.shields.io/npm/v/instantsearch.js.svg?style=flat-square
-[package-url]: https://npmjs.org/package/instantsearch.js
-[ci-svg]: https://img.shields.io/circleci/project/github/algolia/instantsearch.js.svg?style=flat-square
-[ci-url]: https://circleci.com/gh/algolia/instantsearch.js
-[pull-reminders-svg]: https://img.shields.io/badge/pull%20reminders-✓-success.svg?style=flat-square
-[pull-reminders-url]: https://pullreminders.com?ref=badge
-[license-image]: http://img.shields.io/badge/license-MIT-green.svg?style=flat-square
-[license-url]: LICENSE
-
 <!-- Links -->
 
+[license-url]: LICENSE
 [algolia-website]: https://www.algolia.com/?utm_source=instantsearch.js&utm_campaign=repository
 [react-instantsearch-github]: https://github.com/algolia/instantsearch.js/
 [vue-instantsearch-github]: https://github.com/algolia/vue-instantsearch

package/cjs/connectors/current-refinements/connectCurrentRefinements.js

@@ -68,6 +68,7 @@ var connectCurrentRefinements = function connectCurrentRefinements(renderFn) {
             return transformItems(getRefinementsItems({
               results: {},
               helper: helper,
+              indexId: helper.state.index,
               includedAttributes: includedAttributes,
               excludedAttributes: excludedAttributes
             }), {
@@ -78,6 +79,7 @@ var connectCurrentRefinements = function connectCurrentRefinements(renderFn) {
             return accResults.concat(transformItems(getRefinementsItems({
               results: scopedResult.results,
               helper: scopedResult.helper,
+              indexId: scopedResult.indexId,
               includedAttributes: includedAttributes,
               excludedAttributes: excludedAttributes
             }), {
@@ -104,6 +106,7 @@ var connectCurrentRefinements = function connectCurrentRefinements(renderFn) {
 function getRefinementsItems(_ref3) {
   var results = _ref3.results,
     helper = _ref3.helper,
+    indexId = _ref3.indexId,
     includedAttributes = _ref3.includedAttributes,
     excludedAttributes = _ref3.excludedAttributes;
   var includesQuery = (includedAttributes || []).indexOf('query') !== -1 || (excludedAttributes || []).indexOf('query') === -1;
@@ -118,6 +121,7 @@ function getRefinementsItems(_ref3) {
       return item.attribute !== currentItem.attribute;
     })), [{
       indexName: helper.state.index,
+      indexId: indexId,
       attribute: currentItem.attribute,
       label: currentItem.attribute,
       refinements: items.filter(function (result) {

package/cjs/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -209,6 +209,10 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
         var values = uiState.hierarchicalMenu && uiState.hierarchicalMenu[hierarchicalFacetName];
+        if (searchParameters.isConjunctiveFacet(hierarchicalFacetName) || searchParameters.isDisjunctiveFacet(hierarchicalFacetName)) {
+          process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "HierarchicalMenu: Attribute \"".concat(hierarchicalFacetName, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this HierarchicalMenu widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         if (searchParameters.isHierarchicalFacet(hierarchicalFacetName)) {
           var facet = searchParameters.getHierarchicalFacetByName(hierarchicalFacetName);
           process.env.NODE_ENV === 'development' ? (0, _utils.warning)((0, _utils.isEqual)(facet.attributes, attributes) && facet.separator === separator && facet.rootPath === rootPath, 'Using Breadcrumb and HierarchicalMenu on the same facet with different options overrides the configuration of the HierarchicalMenu.') : void 0;

package/cjs/connectors/menu/connectMenu.js

@@ -181,6 +181,10 @@ var connectMenu = function connectMenu(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref5) {
         var uiState = _ref5.uiState;
         var value = uiState.menu && uiState.menu[attribute];
+        if (searchParameters.isConjunctiveFacet(attribute) || searchParameters.isDisjunctiveFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "Menu: Attribute \"".concat(attribute, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this Menu widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         var withFacetConfiguration = searchParameters.removeHierarchicalFacet(attribute).addHierarchicalFacet({
           name: attribute,
           attributes: [attribute]

package/cjs/connectors/refinement-list/connectRefinementList.js

@@ -253,6 +253,14 @@ var connectRefinementList = function connectRefinementList(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
         var isDisjunctive = operator === 'or';
+        if (searchParameters.isHierarchicalFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "RefinementList: Attribute \"".concat(attribute, "\" is already used by another widget applying hierarchical faceting.\nAs this is not supported, please make sure to remove this other widget or this RefinementList widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
+        if (isDisjunctive && searchParameters.isConjunctiveFacet(attribute) || !isDisjunctive && searchParameters.isDisjunctiveFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "RefinementList: Attribute \"".concat(attribute, "\" is used by another refinement list with a different operator.\nAs this is not supported, please make sure to only use this attribute with one of the two operators.")) : void 0;
+          return searchParameters;
+        }
         var values = uiState.refinementList && uiState.refinementList[attribute];
         var withoutRefinements = searchParameters.clearRefinements(attribute);
         var withFacetConfiguration = isDisjunctive ? withoutRefinements.addDisjunctiveFacet(attribute) : withoutRefinements.addFacet(attribute);

package/cjs/connectors/toggle-refinement/connectToggleRefinement.js

@@ -257,6 +257,10 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref11) {
         var uiState = _ref11.uiState;
+        if (searchParameters.isHierarchicalFacet(attribute) || searchParameters.isConjunctiveFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "ToggleRefinement: Attribute \"".concat(attribute, "\" is already used by another widget of a different type.\nAs this is not supported, please make sure to remove this other widget or this ToggleRefinement widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         var withFacetConfiguration = searchParameters.clearRefinements(attribute).addDisjunctiveFacet(attribute);
         var isRefined = Boolean(uiState.toggle && uiState.toggle[attribute]);
         if (isRefined) {

package/cjs/lib/version.js

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

package/cjs/widgets/panel/panel.js

@@ -101,7 +101,7 @@ var panel = function panel(panelWidgetParams) {
         footer: '',
         collapseButtonText: function collapseButtonText(_ref4) {
           var isCollapsed = _ref4.collapsed;
-          return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          width=\"1em\"\n          height=\"1em\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");
+          return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          style=\"width: 1em; height: 1em;\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");
         }
       };
       var renderPanel = renderer({

package/cjs/widgets/places/places.js

@@ -14,6 +14,7 @@ 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); }
 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; }
+/* 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

package/cjs/widgets/search-box/defaultTemplates.js

@@ -39,7 +39,8 @@ var defaultTemplate = {
       className: cssClasses.resetIcon,
       viewBox: "0 0 20 20",
       width: "10",
-      height: "10"
+      height: "10",
+      "aria-hidden": "true"
     }, _ref2);
   },
   submit: function submit(_ref3) {
@@ -48,7 +49,8 @@ var defaultTemplate = {
       className: cssClasses.submitIcon,
       width: "10",
       height: "10",
-      viewBox: "0 0 40 40"
+      viewBox: "0 0 40 40",
+      "aria-hidden": "true"
     }, _ref4);
   },
   loadingIndicator: function loadingIndicator(_ref5) {
@@ -58,7 +60,8 @@ var defaultTemplate = {
       width: "16",
       height: "16",
       viewBox: "0 0 38 38",
-      stroke: "#444"
+      stroke: "#444",
+      "aria-hidden": "true"
     }, _ref6);
   }
 };

package/dist/instantsearch.development.d.ts

@@ -957,6 +957,10 @@ declare type CurrentRefinementsConnectorParamsItem = {
      * The index name.
      */
     indexName: string;
+    /**
+     * The index id as provided to the index widget.
+     */
+    indexId: string;
     /**
      * The attribute on which the refinement is applied.
      */

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.52.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.54.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -2108,6 +2108,7 @@
               return transformItems(getRefinementsItems({
                 results: {},
                 helper: helper,
+                indexId: helper.state.index,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
               }), {
@@ -2118,6 +2119,7 @@
               return accResults.concat(transformItems(getRefinementsItems({
                 results: scopedResult.results,
                 helper: scopedResult.helper,
+                indexId: scopedResult.indexId,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
               }), {
@@ -2144,6 +2146,7 @@
   function getRefinementsItems(_ref3) {
     var results = _ref3.results,
       helper = _ref3.helper,
+      indexId = _ref3.indexId,
       includedAttributes = _ref3.includedAttributes,
       excludedAttributes = _ref3.excludedAttributes;
     var includesQuery = (includedAttributes || []).indexOf('query') !== -1 || (excludedAttributes || []).indexOf('query') === -1;
@@ -2158,6 +2161,7 @@
         return item.attribute !== currentItem.attribute;
       })), [{
         indexName: helper.state.index,
+        indexId: indexId,
         attribute: currentItem.attribute,
         label: currentItem.attribute,
         refinements: items.filter(function (result) {
@@ -2428,6 +2432,10 @@
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
           var uiState = _ref6.uiState;
           var values = uiState.hierarchicalMenu && uiState.hierarchicalMenu[hierarchicalFacetName];
+          if (searchParameters.isConjunctiveFacet(hierarchicalFacetName) || searchParameters.isDisjunctiveFacet(hierarchicalFacetName)) {
+             _warning(false, "HierarchicalMenu: Attribute \"".concat(hierarchicalFacetName, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this HierarchicalMenu widget will not work at all.")) ;
+            return searchParameters;
+          }
           if (searchParameters.isHierarchicalFacet(hierarchicalFacetName)) {
             var facet = searchParameters.getHierarchicalFacetByName(hierarchicalFacetName);
              _warning(isEqual(facet.attributes, attributes) && facet.separator === separator && facet.rootPath === rootPath, 'Using Breadcrumb and HierarchicalMenu on the same facet with different options overrides the configuration of the HierarchicalMenu.') ;
@@ -3273,6 +3281,10 @@
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref5) {
           var uiState = _ref5.uiState;
           var value = uiState.menu && uiState.menu[attribute];
+          if (searchParameters.isConjunctiveFacet(attribute) || searchParameters.isDisjunctiveFacet(attribute)) {
+             _warning(false, "Menu: Attribute \"".concat(attribute, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this Menu widget will not work at all.")) ;
+            return searchParameters;
+          }
           var withFacetConfiguration = searchParameters.removeHierarchicalFacet(attribute).addHierarchicalFacet({
             name: attribute,
             attributes: [attribute]
@@ -4219,6 +4231,14 @@
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
           var uiState = _ref6.uiState;
           var isDisjunctive = operator === 'or';
+          if (searchParameters.isHierarchicalFacet(attribute)) {
+             _warning(false, "RefinementList: Attribute \"".concat(attribute, "\" is already used by another widget applying hierarchical faceting.\nAs this is not supported, please make sure to remove this other widget or this RefinementList widget will not work at all.")) ;
+            return searchParameters;
+          }
+          if (isDisjunctive && searchParameters.isConjunctiveFacet(attribute) || !isDisjunctive && searchParameters.isDisjunctiveFacet(attribute)) {
+             _warning(false, "RefinementList: Attribute \"".concat(attribute, "\" is used by another refinement list with a different operator.\nAs this is not supported, please make sure to only use this attribute with one of the two operators.")) ;
+            return searchParameters;
+          }
           var values = uiState.refinementList && uiState.refinementList[attribute];
           var withoutRefinements = searchParameters.clearRefinements(attribute);
           var withFacetConfiguration = isDisjunctive ? withoutRefinements.addDisjunctiveFacet(attribute) : withoutRefinements.addFacet(attribute);
@@ -4984,6 +5004,10 @@
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref11) {
           var uiState = _ref11.uiState;
+          if (searchParameters.isHierarchicalFacet(attribute) || searchParameters.isConjunctiveFacet(attribute)) {
+             _warning(false, "ToggleRefinement: Attribute \"".concat(attribute, "\" is already used by another widget of a different type.\nAs this is not supported, please make sure to remove this other widget or this ToggleRefinement widget will not work at all.")) ;
+            return searchParameters;
+          }
           var withFacetConfiguration = searchParameters.clearRefinements(attribute).addDisjunctiveFacet(attribute);
           var isRefined = Boolean(uiState.toggle && uiState.toggle[attribute]);
           if (isRefined) {
@@ -13616,7 +13640,7 @@
     };
   }
 
-  var version$1 = '4.52.0';
+  var version$1 = '4.54.0';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -18599,7 +18623,7 @@
           footer: '',
           collapseButtonText: function collapseButtonText(_ref4) {
             var isCollapsed = _ref4.collapsed;
-            return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          width=\"1em\"\n          height=\"1em\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");
+            return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          style=\"width: 1em; height: 1em;\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");
           }
         };
         var renderPanel = renderer$d({
@@ -18669,6 +18693,7 @@
 
   var _excluded$l = ["placesReference", "defaultPosition"],
     _excluded2$4 = ["places"];
+  /* 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
@@ -20237,7 +20262,8 @@
         className: cssClasses.resetIcon,
         viewBox: "0 0 20 20",
         width: "10",
-        height: "10"
+        height: "10",
+        "aria-hidden": "true"
       }, _ref2);
     },
     submit: function submit(_ref3) {
@@ -20246,7 +20272,8 @@
         className: cssClasses.submitIcon,
         width: "10",
         height: "10",
-        viewBox: "0 0 40 40"
+        viewBox: "0 0 40 40",
+        "aria-hidden": "true"
       }, _ref4$1);
     },
     loadingIndicator: function loadingIndicator(_ref5) {
@@ -20256,7 +20283,8 @@
         width: "16",
         height: "16",
         viewBox: "0 0 38 38",
-        stroke: "#444"
+        stroke: "#444",
+        "aria-hidden": "true"
       }, _ref6$1);
     }
   };