instantsearch.js 4.35.0 → 4.36.0

package/es/connectors/dynamic-widgets/connectDynamicWidgets.d.ts

@@ -23,6 +23,20 @@ export declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 export declare type DynamicWidgetsWidgetDescription = {
     $$type: 'ais.dynamicWidgets';

package/es/connectors/dynamic-widgets/connectDynamicWidgets.js

@@ -6,17 +6,22 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
-import { checkRendering, createDocumentationMessageGenerator, getWidgetAttribute, noop } from '../../lib/utils';
+import { checkRendering, createDocumentationMessageGenerator, getWidgetAttribute, noop, warning } from '../../lib/utils';
 var withUsage = createDocumentationMessageGenerator({
   name: 'dynamic-widgets',
   connector: true
 });
+var MAX_WILDCARD_FACETS = 20;
 
 var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
   checkRendering(renderFn, withUsage());
   return function (widgetParams) {
     var widgets = widgetParams.widgets,
+        _widgetParams$maxValu = widgetParams.maxValuesPerFacet,
+        maxValuesPerFacet = _widgetParams$maxValu === void 0 ? 20 : _widgetParams$maxValu,
+        _widgetParams$facets = widgetParams.facets,
+        facets = _widgetParams$facets === void 0 ? ['*'] : _widgetParams$facets,
         _widgetParams$transfo = widgetParams.transformItems,
         transformItems = _widgetParams$transfo === void 0 ? function (items) {
       return items;
@@ -29,6 +34,10 @@ var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
       throw new Error(withUsage('The `widgets` option expects an array of widgets.'));
     }
 
+    if (!(Array.isArray(facets) && facets.length <= 1 && (facets[0] === '*' || facets[0] === undefined))) {
+      throw new Error(withUsage("The `facets` option only accepts [] or [\"*\"], you passed ".concat(JSON.stringify(facets))));
+    }
+
     var localWidgets = new Map();
     return {
       $$type: 'ais.dynamicWidgets',
@@ -108,6 +117,14 @@ var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
         parent.removeWidgets(toRemove);
         unmountFn();
       },
+      getWidgetSearchParameters: function getWidgetSearchParameters(state) {
+        // broadening the scope of facets to avoid conflict between never and *
+        return facets.reduce(function (acc, curr) {
+          return acc.addFacet(curr);
+        }, state.setQueryParameters({
+          maxValuesPerFacet: Math.max(maxValuesPerFacet || 0, state.maxValuesPerFacet || 0)
+        }));
+      },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {
           dynamicWidgets: this.getWidgetRenderState(renderOptions)
@@ -116,7 +133,8 @@ var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
       getWidgetRenderState: function getWidgetRenderState(_ref4) {
         var _results$renderingCon, _results$renderingCon2, _results$renderingCon3, _results$renderingCon4;
 
-        var results = _ref4.results;
+        var results = _ref4.results,
+            state = _ref4.state;
 
         if (!results) {
           return {
@@ -125,11 +143,18 @@ var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
           };
         }
 
-        var attributesToRender = (_results$renderingCon = (_results$renderingCon2 = results.renderingContent) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.facetOrdering) === null || _results$renderingCon3 === void 0 ? void 0 : (_results$renderingCon4 = _results$renderingCon3.facets) === null || _results$renderingCon4 === void 0 ? void 0 : _results$renderingCon4.order) !== null && _results$renderingCon !== void 0 ? _results$renderingCon : [];
+        var attributesToRender = transformItems((_results$renderingCon = (_results$renderingCon2 = results.renderingContent) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.facetOrdering) === null || _results$renderingCon3 === void 0 ? void 0 : (_results$renderingCon4 = _results$renderingCon3.facets) === null || _results$renderingCon4 === void 0 ? void 0 : _results$renderingCon4.order) !== null && _results$renderingCon !== void 0 ? _results$renderingCon : [], {
+          results: results
+        });
+
+        if (!Array.isArray(attributesToRender)) {
+          throw new Error(withUsage('The `transformItems` option expects a function that returns an Array.'));
+        }
+
+        process.env.NODE_ENV === 'development' ? warning(maxValuesPerFacet >= (state.maxValuesPerFacet || 0), "The maxValuesPerFacet set by dynamic widgets (".concat(maxValuesPerFacet, ") is smaller than one of the limits set by a widget (").concat(state.maxValuesPerFacet, "). This causes a mismatch in query parameters and thus an extra network request when that widget is mounted.")) : void 0;
+        process.env.NODE_ENV === 'development' ? warning(attributesToRender.length <= MAX_WILDCARD_FACETS || widgetParams.facets !== undefined, "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.")) : void 0;
         return {
-          attributesToRender: transformItems(attributesToRender, {
-            results: results
-          }),
+          attributesToRender: attributesToRender,
           widgetParams: widgetParams
         };
       }

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.35.0";
+declare const _default: "4.36.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.35.0';
+export default '4.36.0';

package/es/widgets/dynamic-widgets/dynamic-widgets.js

@@ -4,6 +4,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+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 connectDynamicWidgets from '../../connectors/dynamic-widgets/connectDynamicWidgets';
 import { component } from '../../lib/suit';
 import { createDocumentationMessageGenerator, getContainerNode, getWidgetAttribute } from '../../lib/utils';
@@ -24,9 +28,9 @@ function createContainer(rootContainer) {
 var dynamicWidgets = function dynamicWidgets(widgetParams) {
   var _ref = widgetParams || {},
       containerSelector = _ref.container,
-      transformItems = _ref.transformItems,
       widgets = _ref.widgets,
-      fallbackWidget = _ref.fallbackWidget;
+      fallbackWidget = _ref.fallbackWidget,
+      otherWidgetParams = _objectWithoutProperties(_ref, ["container", "widgets", "fallbackWidget"]);
 
   if (!containerSelector) {
     throw new Error(withUsage('The `container` option is required.'));
@@ -61,8 +65,7 @@ var dynamicWidgets = function dynamicWidgets(widgetParams) {
   }, function () {
     userContainer.removeChild(rootContainer);
   });
-  var widget = makeWidget({
-    transformItems: transformItems,
+  var widget = makeWidget(_objectSpread(_objectSpread({}, otherWidgetParams), {}, {
     widgets: connectorWidgets,
     fallbackWidget: typeof fallbackWidget === 'function' ? function (_ref3) {
       var attribute = _ref3.attribute;
@@ -73,7 +76,7 @@ var dynamicWidgets = function dynamicWidgets(widgetParams) {
         container: container
       });
     } : undefined
-  });
+  }));
   return _objectSpread(_objectSpread({}, widget), {}, {
     init: function init(initOptions) {
       widgets.forEach(function (cb) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.35.0",
+  "version": "4.36.0",
   "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",