react-instantsearch-core 6.14.0 → 6.18.0

package/dist/cjs/connectors/connectBreadcrumb.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.getId = void 0;
+exports.getId = exports.default = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 

package/dist/cjs/connectors/connectDynamicWidgets.js

@@ -13,15 +13,20 @@ var _createConnector = _interopRequireDefault(require("../core/createConnector")
 
 var _indexUtils = require("../core/indexUtils");
 
+var MAX_WILDCARD_FACETS = 20;
+
 var _default = (0, _createConnector.default)({
   displayName: 'AlgoliaDynamicWidgets',
   defaultProps: {
     transformItems: function transformItems(items) {
       return items;
-    }
+    },
+    maxValuesPerFacet: 20
   },
   propTypes: {
-    transformItems: _propTypes.default.func
+    transformItems: _propTypes.default.func,
+    facets: _propTypes.default.arrayOf(_propTypes.default.string),
+    maxValuesPerFacet: _propTypes.default.number
   },
   getProvidedProps: function getProvidedProps(props, _searchState, searchResults) {
     var results = (0, _indexUtils.getResults)(searchResults, {
@@ -29,6 +34,10 @@ var _default = (0, _createConnector.default)({
       multiIndexContext: props.indexContextValue
     });
 
+    if (props.facets && !(Array.isArray(props.facets) && props.facets.length <= 1 && (props.facets[0] === '*' || props.facets[0] === undefined))) {
+      throw new Error("The `facets` prop only accepts [] or [\"*\"], you passed ".concat(JSON.stringify(props.facets)));
+    }
+
     if (!results) {
       return {
         attributesToRender: []
@@ -36,11 +45,30 @@ var _default = (0, _createConnector.default)({
     }
 
     var facetOrder = results.renderingContent && results.renderingContent.facetOrdering && results.renderingContent.facetOrdering.facets && results.renderingContent.facetOrdering.facets.order || [];
+    var attributesToRender = props.transformItems(facetOrder, {
+      results: results
+    });
+
+    if (attributesToRender.length > MAX_WILDCARD_FACETS && !props.facets) {
+      // eslint-disable-next-line no-console
+      console.warn("More than ".concat(MAX_WILDCARD_FACETS, " facets are requested to be displayed without explicitly setting which facets to retrieve. This could have a performance impact. Set \"facets\" to [] to do two smaller network requests, or explicitly to ['*'] to avoid this warning."));
+    }
+
+    if (props.maxValuesPerFacet < results._state.maxValuesPerFacet) {
+      // eslint-disable-next-line no-console
+      console.warn("The maxValuesPerFacet set by dynamic widgets (".concat(props.maxValuesPerFacet, ") is smaller than one of the limits set by a widget (").concat(results._state.maxValuesPerFacet, "). This causes a mismatch in query parameters and thus an extra network request when that widget is mounted."));
+    }
+
     return {
-      attributesToRender: props.transformItems(facetOrder, {
-        results: results
-      })
+      attributesToRender: attributesToRender
     };
+  },
+  getSearchParameters: function getSearchParameters(searchParameters, props) {
+    return (props.facets || ['*']).reduce(function (acc, curr) {
+      return acc.addFacet(curr);
+    }, searchParameters.setQueryParameters({
+      maxValuesPerFacet: Math.max(props.maxValuesPerFacet || 0, searchParameters.maxValuesPerFacet || 0)
+    }));
   }
 });
 

package/dist/cjs/connectors/connectHierarchicalMenu.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.getId = void 0;
+exports.getId = exports.default = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 

package/dist/cjs/connectors/connectPoweredBy.js

@@ -19,7 +19,7 @@ var _createConnector = _interopRequireDefault(require("../core/createConnector")
 var _default = (0, _createConnector.default)({
   displayName: 'AlgoliaPoweredBy',
   getProvidedProps: function getProvidedProps() {
-    var hostname = typeof window === 'undefined' ? '' : window.location.hostname;
+    var hostname = typeof window === 'undefined' || typeof window.location === 'undefined' ? '' : window.location.hostname;
     var url = 'https://www.algolia.com/?' + 'utm_source=react-instantsearch&' + 'utm_medium=website&' + "utm_content=".concat(hostname, "&") + 'utm_campaign=poweredby';
     return {
       url: url

package/dist/cjs/core/context.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.IndexProvider = exports.IndexConsumer = exports.InstantSearchProvider = exports.InstantSearchConsumer = exports.instantSearchContext = void 0;
+exports.instantSearchContext = exports.InstantSearchProvider = exports.InstantSearchConsumer = exports.IndexProvider = exports.IndexConsumer = void 0;
 
 var _react = require("react");
 

package/dist/cjs/core/highlight.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.parseAlgoliaHit = parseAlgoliaHit;
 exports.HIGHLIGHT_TAGS = void 0;
+exports.parseAlgoliaHit = parseAlgoliaHit;
 
 var _utils = require("./utils");
 

package/dist/cjs/core/indexUtils.js

@@ -5,12 +5,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.cleanUpValue = cleanUpValue;
+exports.getCurrentRefinementValue = getCurrentRefinementValue;
 exports.getIndexId = getIndexId;
 exports.getResults = getResults;
 exports.hasMultipleIndices = hasMultipleIndices;
 exports.refineValue = refineValue;
-exports.getCurrentRefinementValue = getCurrentRefinementValue;
-exports.cleanUpValue = cleanUpValue;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 

package/dist/cjs/core/metadata.js

@@ -1,14 +1,18 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isMetadataEnabled = isMetadataEnabled;
 exports.getMetadataPayload = getMetadataPayload;
 exports.injectMetadata = injectMetadata;
+exports.isMetadataEnabled = isMetadataEnabled;
+
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 function isMetadataEnabled() {
-  return typeof window !== 'undefined' && window.navigator.userAgent.includes('Algolia Crawler');
+  return (typeof window === "undefined" ? "undefined" : (0, _typeof2.default)(window)) === 'object' && (0, _typeof2.default)(window.navigator) === 'object' && typeof window.navigator.userAgent === 'string' && window.navigator.userAgent.includes('Algolia Crawler') && (0, _typeof2.default)(window.document) === 'object';
 }
 
 function getMetadataPayload(widgets, searchClient) {

package/dist/cjs/core/translatable.js

@@ -40,6 +40,7 @@ var withKeysPropType = function withKeysPropType(keys) {
     var prop = props[propName];
 
     if (prop) {
+      // eslint-disable-next-line no-restricted-syntax
       for (var _i = 0, _Object$keys = Object.keys(prop); _i < _Object$keys.length; _i++) {
         var key = _Object$keys[_i];
 

package/dist/cjs/core/utils.js

@@ -7,11 +7,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.addAbsolutePositions = addAbsolutePositions;
 exports.addQueryID = addQueryID;
+exports.defer = void 0;
 exports.find = find;
+exports.getDisplayName = void 0;
+exports.getObjectType = getObjectType;
+exports.getPropertyByPath = void 0;
 exports.objectHasKeys = objectHasKeys;
 exports.omit = omit;
-exports.getObjectType = getObjectType;
-exports.getPropertyByPath = exports.removeEmptyArraysFromObject = exports.removeEmptyKey = exports.defer = exports.getDisplayName = exports.shallowEqual = void 0;
+exports.shallowEqual = exports.removeEmptyKey = exports.removeEmptyArraysFromObject = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 

package/dist/cjs/core/version.js

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

package/dist/cjs/index.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
+  ExperimentalDynamicWidgets: true,
+  EXPERIMENTAL_connectDynamicWidgets: true,
   createConnector: true,
   instantSearchContext: true,
   InstantSearchConsumer: true,
@@ -15,7 +17,7 @@ var _exportNames = {
   translatable: true,
   Configure: true,
   ExperimentalConfigureRelatedItems: true,
-  ExperimentalDynamicWidgets: true,
+  DynamicWidgets: true,
   QueryRuleContext: true,
   Index: true,
   InstantSearch: true,
@@ -24,7 +26,7 @@ var _exportNames = {
   connectConfigure: true,
   EXPERIMENTAL_connectConfigureRelatedItems: true,
   connectCurrentRefinements: true,
-  EXPERIMENTAL_connectDynamicWidgets: true,
+  connectDynamicWidgets: true,
   connectGeoSearch: true,
   connectHierarchicalMenu: true,
   connectHighlight: true,
@@ -48,64 +50,60 @@ var _exportNames = {
   connectHitInsights: true,
   connectVoiceSearch: true
 };
-Object.defineProperty(exports, "createConnector", {
+Object.defineProperty(exports, "Configure", {
   enumerable: true,
   get: function get() {
-    return _createConnector.default;
+    return _Configure.default;
   }
 });
-Object.defineProperty(exports, "instantSearchContext", {
+Object.defineProperty(exports, "DynamicWidgets", {
   enumerable: true,
   get: function get() {
-    return _context.instantSearchContext;
+    return _DynamicWidgets.default;
   }
 });
-Object.defineProperty(exports, "InstantSearchConsumer", {
+Object.defineProperty(exports, "EXPERIMENTAL_connectConfigureRelatedItems", {
   enumerable: true,
   get: function get() {
-    return _context.InstantSearchConsumer;
+    return _connectConfigureRelatedItems.default;
   }
 });
-Object.defineProperty(exports, "InstantSearchProvider", {
+exports.EXPERIMENTAL_connectDynamicWidgets = void 0;
+Object.defineProperty(exports, "ExperimentalConfigureRelatedItems", {
   enumerable: true,
   get: function get() {
-    return _context.InstantSearchProvider;
+    return _ConfigureRelatedItems.default;
   }
 });
+exports.ExperimentalDynamicWidgets = void 0;
 Object.defineProperty(exports, "HIGHLIGHT_TAGS", {
   enumerable: true,
   get: function get() {
     return _highlight.HIGHLIGHT_TAGS;
   }
 });
-Object.defineProperty(exports, "version", {
-  enumerable: true,
-  get: function get() {
-    return _version.default;
-  }
-});
-Object.defineProperty(exports, "translatable", {
+Object.defineProperty(exports, "Index", {
   enumerable: true,
   get: function get() {
-    return _translatable.default;
+    return _Index.default;
   }
 });
-Object.defineProperty(exports, "Configure", {
+Object.defineProperty(exports, "InstantSearch", {
   enumerable: true,
   get: function get() {
-    return _Configure.default;
+    return _InstantSearch.default;
   }
 });
-Object.defineProperty(exports, "ExperimentalConfigureRelatedItems", {
+Object.defineProperty(exports, "InstantSearchConsumer", {
   enumerable: true,
   get: function get() {
-    return _ConfigureRelatedItems.default;
+    return _context.InstantSearchConsumer;
   }
 });
-Object.defineProperty(exports, "ExperimentalDynamicWidgets", {
+Object.defineProperty(exports, "InstantSearchProvider", {
   enumerable: true,
   get: function get() {
-    return _DynamicWidgets.default;
+    return _context.InstantSearchProvider;
   }
 });
 Object.defineProperty(exports, "QueryRuleContext", {
@@ -114,18 +112,6 @@ Object.defineProperty(exports, "QueryRuleContext", {
     return _QueryRuleContext.default;
   }
 });
-Object.defineProperty(exports, "Index", {
-  enumerable: true,
-  get: function get() {
-    return _Index.default;
-  }
-});
-Object.defineProperty(exports, "InstantSearch", {
-  enumerable: true,
-  get: function get() {
-    return _InstantSearch.default;
-  }
-});
 Object.defineProperty(exports, "connectAutoComplete", {
   enumerable: true,
   get: function get() {
@@ -144,19 +130,13 @@ Object.defineProperty(exports, "connectConfigure", {
     return _connectConfigure.default;
   }
 });
-Object.defineProperty(exports, "EXPERIMENTAL_connectConfigureRelatedItems", {
-  enumerable: true,
-  get: function get() {
-    return _connectConfigureRelatedItems.default;
-  }
-});
 Object.defineProperty(exports, "connectCurrentRefinements", {
   enumerable: true,
   get: function get() {
     return _connectCurrentRefinements.default;
   }
 });
-Object.defineProperty(exports, "EXPERIMENTAL_connectDynamicWidgets", {
+Object.defineProperty(exports, "connectDynamicWidgets", {
   enumerable: true,
   get: function get() {
     return _connectDynamicWidgets.default;
@@ -180,6 +160,12 @@ Object.defineProperty(exports, "connectHighlight", {
     return _connectHighlight.default;
   }
 });
+Object.defineProperty(exports, "connectHitInsights", {
+  enumerable: true,
+  get: function get() {
+    return _connectHitInsights.default;
+  }
+});
 Object.defineProperty(exports, "connectHits", {
   enumerable: true,
   get: function get() {
@@ -240,22 +226,22 @@ Object.defineProperty(exports, "connectRefinementList", {
     return _connectRefinementList.default;
   }
 });
-Object.defineProperty(exports, "connectScrollTo", {
+Object.defineProperty(exports, "connectRelevantSort", {
   enumerable: true,
   get: function get() {
-    return _connectScrollTo.default;
+    return _connectRelevantSort.default;
   }
 });
-Object.defineProperty(exports, "connectSearchBox", {
+Object.defineProperty(exports, "connectScrollTo", {
   enumerable: true,
   get: function get() {
-    return _connectSearchBox.default;
+    return _connectScrollTo.default;
   }
 });
-Object.defineProperty(exports, "connectRelevantSort", {
+Object.defineProperty(exports, "connectSearchBox", {
   enumerable: true,
   get: function get() {
-    return _connectRelevantSort.default;
+    return _connectSearchBox.default;
   }
 });
 Object.defineProperty(exports, "connectSortBy", {
@@ -282,16 +268,34 @@ Object.defineProperty(exports, "connectToggleRefinement", {
     return _connectToggleRefinement.default;
   }
 });
-Object.defineProperty(exports, "connectHitInsights", {
+Object.defineProperty(exports, "connectVoiceSearch", {
   enumerable: true,
   get: function get() {
-    return _connectHitInsights.default;
+    return _connectVoiceSearch.default;
   }
 });
-Object.defineProperty(exports, "connectVoiceSearch", {
+Object.defineProperty(exports, "createConnector", {
   enumerable: true,
   get: function get() {
-    return _connectVoiceSearch.default;
+    return _createConnector.default;
+  }
+});
+Object.defineProperty(exports, "instantSearchContext", {
+  enumerable: true,
+  get: function get() {
+    return _context.instantSearchContext;
+  }
+});
+Object.defineProperty(exports, "translatable", {
+  enumerable: true,
+  get: function get() {
+    return _translatable.default;
+  }
+});
+Object.defineProperty(exports, "version", {
+  enumerable: true,
+  get: function get() {
+    return _version.default;
   }
 });
 
@@ -385,4 +389,15 @@ Object.keys(_types).forEach(function (key) {
       return _types[key];
     }
   });
-});
+});
+// Core
+// Utils
+// Widgets
+
+/** @deprecated use DynamicWidgets */
+var ExperimentalDynamicWidgets = _DynamicWidgets.default;
+exports.ExperimentalDynamicWidgets = ExperimentalDynamicWidgets;
+
+/** @deprecated use connectDynamicWidgets */
+var EXPERIMENTAL_connectDynamicWidgets = _connectDynamicWidgets.default;
+exports.EXPERIMENTAL_connectDynamicWidgets = EXPERIMENTAL_connectDynamicWidgets;

package/dist/es/connectors/connectDynamicWidgets.js

@@ -1,15 +1,19 @@
 import PropTypes from 'prop-types';
 import createConnector from '../core/createConnector';
 import { getResults } from '../core/indexUtils';
+var MAX_WILDCARD_FACETS = 20;
 export default createConnector({
   displayName: 'AlgoliaDynamicWidgets',
   defaultProps: {
     transformItems: function transformItems(items) {
       return items;
-    }
+    },
+    maxValuesPerFacet: 20
   },
   propTypes: {
-    transformItems: PropTypes.func
+    transformItems: PropTypes.func,
+    facets: PropTypes.arrayOf(PropTypes.string),
+    maxValuesPerFacet: PropTypes.number
   },
   getProvidedProps: function getProvidedProps(props, _searchState, searchResults) {
     var results = getResults(searchResults, {
@@ -17,6 +21,10 @@ export default createConnector({
       multiIndexContext: props.indexContextValue
     });
 
+    if (props.facets && !(Array.isArray(props.facets) && props.facets.length <= 1 && (props.facets[0] === '*' || props.facets[0] === undefined))) {
+      throw new Error("The `facets` prop only accepts [] or [\"*\"], you passed ".concat(JSON.stringify(props.facets)));
+    }
+
     if (!results) {
       return {
         attributesToRender: []
@@ -24,10 +32,29 @@ export default createConnector({
     }
 
     var facetOrder = results.renderingContent && results.renderingContent.facetOrdering && results.renderingContent.facetOrdering.facets && results.renderingContent.facetOrdering.facets.order || [];
+    var attributesToRender = props.transformItems(facetOrder, {
+      results: results
+    });
+
+    if (attributesToRender.length > MAX_WILDCARD_FACETS && !props.facets) {
+      // eslint-disable-next-line no-console
+      console.warn("More than ".concat(MAX_WILDCARD_FACETS, " facets are requested to be displayed without explicitly setting which facets to retrieve. This could have a performance impact. Set \"facets\" to [] to do two smaller network requests, or explicitly to ['*'] to avoid this warning."));
+    }
+
+    if (props.maxValuesPerFacet < results._state.maxValuesPerFacet) {
+      // eslint-disable-next-line no-console
+      console.warn("The maxValuesPerFacet set by dynamic widgets (".concat(props.maxValuesPerFacet, ") is smaller than one of the limits set by a widget (").concat(results._state.maxValuesPerFacet, "). This causes a mismatch in query parameters and thus an extra network request when that widget is mounted."));
+    }
+
     return {
-      attributesToRender: props.transformItems(facetOrder, {
-        results: results
-      })
+      attributesToRender: attributesToRender
     };
+  },
+  getSearchParameters: function getSearchParameters(searchParameters, props) {
+    return (props.facets || ['*']).reduce(function (acc, curr) {
+      return acc.addFacet(curr);
+    }, searchParameters.setQueryParameters({
+      maxValuesPerFacet: Math.max(props.maxValuesPerFacet || 0, searchParameters.maxValuesPerFacet || 0)
+    }));
   }
 });

package/dist/es/connectors/connectPoweredBy.js

@@ -10,7 +10,7 @@ import createConnector from '../core/createConnector';
 export default createConnector({
   displayName: 'AlgoliaPoweredBy',
   getProvidedProps: function getProvidedProps() {
-    var hostname = typeof window === 'undefined' ? '' : window.location.hostname;
+    var hostname = typeof window === 'undefined' || typeof window.location === 'undefined' ? '' : window.location.hostname;
     var url = 'https://www.algolia.com/?' + 'utm_source=react-instantsearch&' + 'utm_medium=website&' + "utm_content=".concat(hostname, "&") + 'utm_campaign=poweredby';
     return {
       url: url

package/dist/es/core/metadata.js

@@ -1,5 +1,6 @@
+import _typeof from "@babel/runtime/helpers/esm/typeof";
 export function isMetadataEnabled() {
-  return typeof window !== 'undefined' && window.navigator.userAgent.includes('Algolia Crawler');
+  return (typeof window === "undefined" ? "undefined" : _typeof(window)) === 'object' && _typeof(window.navigator) === 'object' && typeof window.navigator.userAgent === 'string' && window.navigator.userAgent.includes('Algolia Crawler') && _typeof(window.document) === 'object';
 }
 export function getMetadataPayload(widgets, searchClient) {
   var internalProps = ['contextValue', 'indexContextValue'];

package/dist/es/core/translatable.js

@@ -18,6 +18,7 @@ var withKeysPropType = function withKeysPropType(keys) {
     var prop = props[propName];
 
     if (prop) {
+      // eslint-disable-next-line no-restricted-syntax
       for (var _i = 0, _Object$keys = Object.keys(prop); _i < _Object$keys.length; _i++) {
         var key = _Object$keys[_i];
 

package/dist/es/core/version.js

@@ -1 +1 @@
-export default '6.14.0';
+export default '6.18.0';

package/dist/es/index.js

@@ -8,7 +8,11 @@ export { default as translatable } from './core/translatable'; // Widgets
 
 export { default as Configure } from './widgets/Configure';
 export { default as ExperimentalConfigureRelatedItems } from './widgets/ConfigureRelatedItems';
-export { default as ExperimentalDynamicWidgets } from './widgets/DynamicWidgets';
+import { default as DynamicWidgets } from './widgets/DynamicWidgets';
+/** @deprecated use DynamicWidgets */
+
+var ExperimentalDynamicWidgets = DynamicWidgets;
+export { ExperimentalDynamicWidgets, DynamicWidgets };
 export { default as QueryRuleContext } from './widgets/QueryRuleContext';
 export { default as Index } from './widgets/Index';
 export { default as InstantSearch } from './widgets/InstantSearch'; // Connectors
@@ -18,7 +22,11 @@ export { default as connectBreadcrumb } from './connectors/connectBreadcrumb';
 export { default as connectConfigure } from './connectors/connectConfigure';
 export { default as EXPERIMENTAL_connectConfigureRelatedItems } from './connectors/connectConfigureRelatedItems';
 export { default as connectCurrentRefinements } from './connectors/connectCurrentRefinements';
-export { default as EXPERIMENTAL_connectDynamicWidgets } from './connectors/connectDynamicWidgets';
+import { default as connectDynamicWidgets } from './connectors/connectDynamicWidgets';
+/** @deprecated use connectDynamicWidgets */
+
+var EXPERIMENTAL_connectDynamicWidgets = connectDynamicWidgets;
+export { connectDynamicWidgets, EXPERIMENTAL_connectDynamicWidgets };
 export { default as connectGeoSearch } from './connectors/connectGeoSearch';
 export { default as connectHierarchicalMenu } from './connectors/connectHierarchicalMenu';
 export { default as connectHighlight } from './connectors/connectHighlight';