instantsearch.js 4.57.0 → 4.59.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.57.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.59.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -752,7 +752,9 @@
       }
       var facetValue = args[1],
         _args$ = args[2],
-        eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
+        eventName = _args$ === void 0 ? 'Filter Applied' : _args$,
+        _args$2 = args[3],
+        additionalData = _args$2 === void 0 ? {} : _args$2;
       var _args$0$split = args[0].split(':'),
         _args$0$split2 = _slicedToArray(_args$0$split, 2),
         eventType = _args$0$split2[0],
@@ -760,7 +762,7 @@
       var attribute = typeof attr === 'string' ? attr : attr(facetValue);
       if (args.length === 1 && _typeof(args[0]) === 'object') {
         instantSearchInstance.sendEventToInsights(args[0]);
-      } else if (eventType === 'click' && (args.length === 2 || args.length === 3)) {
+      } else if (eventType === 'click' && args.length >= 2 && args.length <= 4) {
         if (!isFacetRefined(helper, attribute, facetValue)) {
           // send event only when the facet is being checked "ON"
           instantSearchInstance.sendEventToInsights({
@@ -768,16 +770,16 @@
             widgetType: widgetType,
             eventType: eventType,
             eventModifier: eventModifier,
-            payload: {
+            payload: _objectSpread2({
               eventName: eventName,
               index: helper.getIndex(),
               filters: ["".concat(attribute, ":").concat(facetValue)]
-            },
+            }, additionalData),
             attribute: attribute
           });
         }
       } else {
-        throw new Error("You need to pass two arguments like:\n  sendEvent('click', facetValue);\n\nIf you want to send a custom payload, you can pass one object: sendEvent(customPayload);\n");
+        throw new Error("You need to pass between two and four arguments like:\n  sendEvent('click', facetValue, eventName?, additionalData?);\n\nIf you want to send a custom payload, you can pass one object: sendEvent(customPayload);\n");
       }
     };
     return sendEventForFacet;
@@ -814,6 +816,7 @@
       eventModifier = _args$0$split2[1];
     var hits = args[1];
     var eventName = args[2];
+    var additionalData = args[3] || {};
     if (!hits) {
       {
         throw new Error("You need to pass hit or hits as the second argument like:\n  ".concat(methodName, "(eventType, hit);\n  "));
@@ -849,11 +852,11 @@
           insightsMethod: 'viewedObjectIDs',
           widgetType: widgetType,
           eventType: eventType,
-          payload: {
+          payload: _objectSpread2({
             eventName: eventName || 'Hits Viewed',
             index: index,
             objectIDs: objectIDsByChunk[i]
-          },
+          }, additionalData),
           hits: batch,
           eventModifier: eventModifier
         };
@@ -864,13 +867,13 @@
           insightsMethod: 'clickedObjectIDsAfterSearch',
           widgetType: widgetType,
           eventType: eventType,
-          payload: {
+          payload: _objectSpread2({
             eventName: eventName || 'Hit Clicked',
             index: index,
             queryID: queryID,
             objectIDs: objectIDsByChunk[i],
             positions: positionsByChunk[i]
-          },
+          }, additionalData),
           hits: batch,
           eventModifier: eventModifier
         };
@@ -881,12 +884,12 @@
           insightsMethod: 'convertedObjectIDsAfterSearch',
           widgetType: widgetType,
           eventType: eventType,
-          payload: {
+          payload: _objectSpread2({
             eventName: eventName || 'Hit Converted',
             index: index,
             queryID: queryID,
             objectIDs: objectIDsByChunk[i]
-          },
+          }, additionalData),
           hits: batch,
           eventModifier: eventModifier
         };
@@ -9911,7 +9914,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.14.2';
+  var version = '3.15.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -12554,7 +12557,9 @@
       insightsInitParams = props.insightsInitParams,
       onEvent = props.onEvent,
       _props$$$internal = props.$$internal,
-      $$internal = _props$$$internal === void 0 ? false : _props$$$internal;
+      $$internal = _props$$$internal === void 0 ? false : _props$$$internal,
+      _props$$$automatic = props.$$automatic,
+      $$automatic = _props$$$automatic === void 0 ? false : _props$$$automatic;
     var potentialInsightsClient = _insightsClient;
     if (!_insightsClient && _insightsClient !== null) {
       safelyRunOnBrowser(function (_ref) {
@@ -12645,6 +12650,7 @@
       return {
         $$type: 'ais.insights',
         $$internal: $$internal,
+        $$automatic: $$automatic,
         onStateChange: function onStateChange() {},
         subscribe: function subscribe() {
           if (!insightsClient.shouldAddScript) return;
@@ -12665,14 +12671,19 @@
         },
         started: function started() {
           insightsClient('addAlgoliaAgent', 'insights-middleware');
-          helper = instantSearchInstance.helper;
+          helper = instantSearchInstance.mainHelper;
           initialParameters = {
             userToken: helper.state.userToken,
             clickAnalytics: helper.state.clickAnalytics
           };
-          helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread2(_objectSpread2({}, helper.state), {}, {
-            clickAnalytics: true
-          }));
+
+          // We don't want to force clickAnalytics when the insights is enabled from the search response.
+          // This means we don't enable insights for indices that don't opt in
+          if (!$$automatic) {
+            helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread2(_objectSpread2({}, helper.state), {}, {
+              clickAnalytics: true
+            }));
+          }
           if (!$$internal) {
             instantSearchInstance.scheduleSearch();
           }
@@ -12739,6 +12750,9 @@
             } else if (event.insightsMethod) {
               // Source is used to differentiate events sent by instantsearch from those sent manually.
               event.payload.algoliaSource = ['instantsearch'];
+              if ($$automatic) {
+                event.payload.algoliaSource.push('instantsearch-automatic');
+              }
               if (event.eventModifier === 'internal') {
                 event.payload.algoliaSource.push('instantsearch-internal');
               }
@@ -14272,7 +14286,7 @@
           return widgets.indexOf(widget) === -1;
         });
         if (localInstantSearchInstance && Boolean(widgets.length)) {
-          var _nextState = widgets.reduce(function (state, widget) {
+          var cleanedState = widgets.reduce(function (state, widget) {
             // the `dispose` method exists at this point we already assert it
             var next = widget.dispose({
               helper: helper,
@@ -14281,14 +14295,23 @@
             });
             return next || state;
           }, helper.state);
+          var newState = localInstantSearchInstance.future.preserveSharedStateOnUnmount ? getLocalWidgetsSearchParameters(localWidgets, {
+            uiState: localUiState,
+            initialSearchParameters: new algoliasearchHelper_1.SearchParameters({
+              index: this.getIndexName()
+            })
+          }) : getLocalWidgetsSearchParameters(localWidgets, {
+            uiState: getLocalWidgetsUiState(localWidgets, {
+              searchParameters: cleanedState,
+              helper: helper
+            }),
+            initialSearchParameters: cleanedState
+          });
           localUiState = getLocalWidgetsUiState(localWidgets, {
-            searchParameters: _nextState,
+            searchParameters: newState,
             helper: helper
           });
-          helper.setState(getLocalWidgetsSearchParameters(localWidgets, {
-            uiState: localUiState,
-            initialSearchParameters: _nextState
-          }));
+          helper.setState(newState);
           if (localWidgets.length) {
             localInstantSearchInstance.scheduleSearch();
           }
@@ -14354,7 +14377,7 @@
           return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
         };
         derivedHelper = mainHelper.derive(function () {
-          return mergeSearchParameters.apply(void 0, _toConsumableArray(resolveSearchParameters(_this3)));
+          return mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray(resolveSearchParameters(_this3))));
         });
         var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
         if (indexInitialResults) {
@@ -14617,7 +14640,7 @@
     };
   }
 
-  var version$1 = '4.57.0';
+  var version$1 = '4.59.0';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -14632,6 +14655,10 @@
   /**
    * Global options for an InstantSearch instance.
    */
+  var INSTANTSEARCH_FUTURE_DEFAULTS = {
+    preserveSharedStateOnUnmount: false
+  };
+
   /**
    * The actual implementation of the InstantSearch. This is
    * created using the `instantsearch` factory function.
@@ -14641,6 +14668,7 @@
     _inherits(InstantSearch, _EventEmitter);
     var _super = _createSuper(InstantSearch);
     function InstantSearch(options) {
+      var _options$future2;
       var _this;
       _classCallCheck(this, InstantSearch);
       _this = _super.call(this);
@@ -14650,6 +14678,7 @@
       _defineProperty(_assertThisInitialized(_this), "indexName", void 0);
       _defineProperty(_assertThisInitialized(_this), "insightsClient", void 0);
       _defineProperty(_assertThisInitialized(_this), "onStateChange", null);
+      _defineProperty(_assertThisInitialized(_this), "future", void 0);
       _defineProperty(_assertThisInitialized(_this), "helper", void 0);
       _defineProperty(_assertThisInitialized(_this), "mainHelper", void 0);
       _defineProperty(_assertThisInitialized(_this), "mainIndex", void 0);
@@ -14663,6 +14692,7 @@
       _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
       _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
       _defineProperty(_assertThisInitialized(_this), "_mainHelperSearch", void 0);
+      _defineProperty(_assertThisInitialized(_this), "_insights", void 0);
       _defineProperty(_assertThisInitialized(_this), "middleware", []);
       _defineProperty(_assertThisInitialized(_this), "sendEventToInsights", void 0);
       /**
@@ -14713,7 +14743,7 @@
         _options$routing = options.routing,
         routing = _options$routing === void 0 ? null : _options$routing,
         _options$insights = options.insights,
-        insights = _options$insights === void 0 ? false : _options$insights,
+        insights = _options$insights === void 0 ? undefined : _options$insights,
         searchFunction = options.searchFunction,
         _options$stalledSearc = options.stalledSearchDelay,
         stalledSearchDelay = _options$stalledSearc === void 0 ? 200 : _options$stalledSearc,
@@ -14722,7 +14752,9 @@
         _options$insightsClie = options.insightsClient,
         insightsClient = _options$insightsClie === void 0 ? null : _options$insightsClie,
         _options$onStateChang = options.onStateChange,
-        onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang;
+        onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang,
+        _options$future = options.future,
+        future = _options$future === void 0 ? _objectSpread2(_objectSpread2({}, INSTANTSEARCH_FUTURE_DEFAULTS), options.future || {}) : _options$future;
       if (searchClient === null) {
         throw new Error(withUsage$r('The `searchClient` option is required.'));
       }
@@ -14739,7 +14771,14 @@
        _warning(!options.searchParameters, "The `searchParameters` option is deprecated and will not be supported in InstantSearch.js 4.x.\n\nYou can replace it with the `configure` widget:\n\n```\nsearch.addWidgets([\n  configure(".concat(JSON.stringify(options.searchParameters, null, 2), ")\n]);\n```\n\nSee ").concat(createDocumentationLink({
         name: 'configure'
       }))) ;
+      if ( ((_options$future2 = options.future) === null || _options$future2 === void 0 ? void 0 : _options$future2.preserveSharedStateOnUnmount) === undefined) {
+        // eslint-disable-next-line no-console
+        console.info("Starting from the next major version, InstantSearch will change how widgets state is preserved when they are removed. InstantSearch will keep the state of unmounted widgets to be usable by other widgets with the same attribute.\n\nWe recommend setting `future.preserveSharedStateOnUnmount` to true to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to false.\n\nSee documentation: ".concat(createDocumentationLink({
+          name: 'instantsearch'
+        }), "#widget-param-future\n          "));
+      }
       _this.client = searchClient;
+      _this.future = future;
       _this.insightsClient = insightsClient;
       _this.indexName = indexName;
       _this.helper = null;
@@ -14760,6 +14799,7 @@
       _this._createURL = defaultCreateURL;
       _this._initialUiState = initialUiState;
       _this._initialResults = null;
+      _this._insights = insights;
       if (searchFunction) {
          _warning(false, "The `searchFunction` option is deprecated. Use `onStateChange` instead.") ;
         _this._searchFunction = searchFunction;
@@ -14771,8 +14811,9 @@
         _this.use(createRouterMiddleware(routerOptions));
       }
 
-      // This is the default middleware,
-      // any user-provided middleware will be added later and override this one.
+      // This is the default Insights middleware,
+      // added when `insights` is set to true by the user.
+      // Any user-provided middleware will be added later and override this one.
       if (insights) {
         var insightsOptions = typeof insights === 'boolean' ? {} : insights;
         insightsOptions.$$internal = true;
@@ -15064,6 +15105,24 @@
           var instance = _ref6.instance;
           instance.started();
         });
+
+        // This is the automatic Insights middleware,
+        // added when `insights` is unset and the initial results possess `queryID`.
+        // Any user-provided middleware will be added later and override this one.
+        if (typeof this._insights === 'undefined') {
+          mainHelper.derivedHelpers[0].once('result', function () {
+            var hasAutomaticInsights = _this3.mainIndex.getScopedResults().some(function (_ref7) {
+              var results = _ref7.results;
+              return results === null || results === void 0 ? void 0 : results._automaticInsights;
+            });
+            if (hasAutomaticInsights) {
+              _this3.use(createInsightsMiddleware({
+                $$internal: true,
+                $$automatic: true
+              }));
+            }
+          });
+        }
       }
 
       /**
@@ -15093,8 +15152,8 @@
         (_this$mainHelper2 = this.mainHelper) === null || _this$mainHelper2 === void 0 ? void 0 : _this$mainHelper2.removeAllListeners();
         this.mainHelper = null;
         this.helper = null;
-        this.middleware.forEach(function (_ref7) {
-          var instance = _ref7.instance;
+        this.middleware.forEach(function (_ref8) {
+          var instance = _ref8.instance;
           instance.unsubscribe();
         });
       }
@@ -16110,7 +16169,6 @@
   var _objectWithoutProperties$1 = unwrapExports(objectWithoutProperties);
 
   var _excluded$9 = ["parts", "highlightedTagName", "nonHighlightedTagName", "separator", "className", "classNames"];
-  // This is a minimal subset of the actual types from the `JSX` namespace.
 
   function createHighlightPartComponent(_ref) {
     var createElement = _ref.createElement;
@@ -16134,18 +16192,20 @@
       createElement: createElement,
       Fragment: Fragment
     });
-    return function Highlight(_ref4) {
-      var parts = _ref4.parts,
-          _ref4$highlightedTagN = _ref4.highlightedTagName,
-          highlightedTagName = _ref4$highlightedTagN === void 0 ? 'mark' : _ref4$highlightedTagN,
-          _ref4$nonHighlightedT = _ref4.nonHighlightedTagName,
-          nonHighlightedTagName = _ref4$nonHighlightedT === void 0 ? 'span' : _ref4$nonHighlightedT,
-          _ref4$separator = _ref4.separator,
-          separator = _ref4$separator === void 0 ? ', ' : _ref4$separator,
-          className = _ref4.className,
-          _ref4$classNames = _ref4.classNames,
-          classNames = _ref4$classNames === void 0 ? {} : _ref4$classNames,
-          props = _objectWithoutProperties$1(_ref4, _excluded$9);
+    return function Highlight(userProps) {
+      // Not destructured in function signature, to make sure it's not exposed in
+      // the type definition.
+      var parts = userProps.parts,
+          _userProps$highlighte = userProps.highlightedTagName,
+          highlightedTagName = _userProps$highlighte === void 0 ? 'mark' : _userProps$highlighte,
+          _userProps$nonHighlig = userProps.nonHighlightedTagName,
+          nonHighlightedTagName = _userProps$nonHighlig === void 0 ? 'span' : _userProps$nonHighlig,
+          _userProps$separator = userProps.separator,
+          separator = _userProps$separator === void 0 ? ', ' : _userProps$separator,
+          className = userProps.className,
+          _userProps$classNames = userProps.classNames,
+          classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
+          props = _objectWithoutProperties$1(userProps, _excluded$9);
 
       return createElement("span", _extends$1({}, props, {
         className: cx(classNames.root, className)
@@ -17731,6 +17791,7 @@
     searchAsYouType: true,
     isSearchStalled: false,
     disabled: false,
+    ariaLabel: 'Search',
     onChange: noop,
     onSubmit: noop,
     onReset: noop,
@@ -17847,7 +17908,8 @@
           showReset = _this$props4.showReset,
           showLoadingIndicator = _this$props4.showLoadingIndicator,
           templates = _this$props4.templates,
-          isSearchStalled = _this$props4.isSearchStalled;
+          isSearchStalled = _this$props4.isSearchStalled,
+          ariaLabel = _this$props4.ariaLabel;
         return h("div", {
           className: cssClasses.root
         }, h("form", {
@@ -17874,7 +17936,8 @@
           maxLength: 512,
           onInput: this.onInput,
           onBlur: this.onBlur,
-          onFocus: this.onFocus
+          onFocus: this.onFocus,
+          "aria-label": ariaLabel
         }), h(Template, {
           templateKey: "submit",
           rootTagName: "button",
@@ -18123,7 +18186,8 @@
           // This sets the search box to a controlled state because
           // we don't rely on the `refine` prop but on `onChange`.
           ,
-          searchAsYouType: false
+          searchAsYouType: false,
+          ariaLabel: "Search for filters"
         }));
         var facetValues = this.props.facetValues && this.props.facetValues.length > 0 && h("ul", {
           className: this.props.cssClasses.list
@@ -18492,13 +18556,15 @@
     var currentValue = _ref.currentValue,
       options = _ref.options,
       cssClasses = _ref.cssClasses,
-      setValue = _ref.setValue;
+      setValue = _ref.setValue,
+      ariaLabel = _ref.ariaLabel;
     return h("select", {
       className: cx(cssClasses.select),
       onChange: function onChange(event) {
         return setValue(event.target.value);
       },
-      value: "".concat(currentValue)
+      value: "".concat(currentValue),
+      "aria-label": ariaLabel
     }, options.map(function (option) {
       return h("option", {
         className: cx(cssClasses.option),
@@ -19158,7 +19224,7 @@
     }, h("ul", {
       className: props.cssClasses.list
     }, props.showFirst && h(PaginationLink, {
-      ariaLabel: "First",
+      ariaLabel: "First Page",
       className: props.cssClasses.firstPageItem,
       isDisabled: props.isFirstPage,
       templates: props.templates,
@@ -19168,7 +19234,7 @@
       cssClasses: props.cssClasses,
       createClickHandler: createClickHandler
     }), props.showPrevious && h(PaginationLink, {
-      ariaLabel: "Previous",
+      ariaLabel: "Previous Page",
       className: props.cssClasses.previousPageItem,
       isDisabled: props.isFirstPage,
       templates: props.templates,
@@ -19191,7 +19257,7 @@
         createClickHandler: createClickHandler
       });
     }), props.showNext && h(PaginationLink, {
-      ariaLabel: "Next",
+      ariaLabel: "Next Page",
       className: props.cssClasses.nextPageItem,
       isDisabled: props.isLastPage,
       templates: props.templates,
@@ -19201,7 +19267,7 @@
       cssClasses: props.cssClasses,
       createClickHandler: createClickHandler
     }), props.showLast && h(PaginationLink, {
-      ariaLabel: "Last",
+      ariaLabel: "Last Page, Page ".concat(props.nbPages),
       className: props.cssClasses.lastPageItem,
       isDisabled: props.isLastPage,
       templates: props.templates,
@@ -20698,8 +20764,10 @@
           parseFloat(props['aria-valuenow']) * 100) / 100;
           var value = _typeof(tooltips) === 'object' && tooltips.format ? tooltips.format(roundedValue) : roundedValue;
           var className = cx(props.className, props['data-handle-key'] === 0 && 'rheostat-handle-lower', props['data-handle-key'] === 1 && 'rheostat-handle-upper');
+          var ariaLabel = props['data-handle-key'] === 0 ? 'Minimum Filter Handle' : 'Maximum Filter Handle';
           return h("div", _extends({}, props, {
-            className: className
+            className: className,
+            "aria-label": ariaLabel
           }), tooltips && h("div", {
             className: "rheostat-tooltip"
           }, value));
@@ -21621,7 +21689,8 @@
         cssClasses: cssClasses,
         currentValue: currentRefinement,
         options: options,
-        setValue: refine
+        setValue: refine,
+        ariaLabel: "Sort results by"
       })), containerNode);
     };
   };