instantsearch.js 4.58.0 → 4.60.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.58.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.60.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
         };
@@ -1408,6 +1411,111 @@
     });
   }
 
+  // @ts-nocheck (types to be fixed during actual implementation)
+
+  function hydrateSearchClient(client, results) {
+    if (!results) {
+      return;
+    }
+
+    // Disable cache hydration on:
+    // - Algoliasearch API Client < v4 with cache disabled
+    // - Third party clients (detected by the `addAlgoliaAgent` function missing)
+
+    if ((!client.transporter || client._cacheHydrated) && (!client._useCache || typeof client.addAlgoliaAgent !== 'function')) {
+      return;
+    }
+
+    // Algoliasearch API Client >= v4
+    // To hydrate the client we need to populate the cache with the data from
+    // the server (done in `hydrateSearchClientWithMultiIndexRequest` or
+    // `hydrateSearchClientWithSingleIndexRequest`). But since there is no way
+    // for us to compute the key the same way as `algoliasearch-client` we need
+    // to populate it on a custom key and override the `search` method to
+    // search on it first.
+    if (client.transporter && !client._cacheHydrated) {
+      client._cacheHydrated = true;
+      var baseMethod = client.search;
+      client.search = function (requests) {
+        for (var _len = arguments.length, methodArgs = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+          methodArgs[_key - 1] = arguments[_key];
+        }
+        var requestsWithSerializedParams = requests.map(function (request) {
+          return _objectSpread2(_objectSpread2({}, request), {}, {
+            params: serializeQueryParameters(request.params)
+          });
+        });
+        return client.transporter.responsesCache.get({
+          method: 'search',
+          args: [requestsWithSerializedParams].concat(methodArgs)
+        }, function () {
+          return baseMethod.apply(void 0, [requests].concat(methodArgs));
+        });
+      };
+
+      // Populate the cache with the data from the server
+      client.transporter.responsesCache.set({
+        method: 'search',
+        args: [Object.keys(results).reduce(function (acc, key) {
+          return acc.concat(results[key].results.map(function (request) {
+            return {
+              indexName: request.index,
+              params: request.params
+            };
+          }));
+        }, [])]
+      }, {
+        results: Object.keys(results).reduce(function (acc, key) {
+          return acc.concat(results[key].results);
+        }, [])
+      });
+    }
+
+    // Algoliasearch API Client < v4
+    // Prior to client v4 we didn't have a proper API to hydrate the client
+    // cache from the outside. The following code populates the cache with
+    // a single-index result. You can find more information about the
+    // computation of the key inside the client (see link below).
+    // https://github.com/algolia/algoliasearch-client-javascript/blob/c27e89ff92b2a854ae6f40dc524bffe0f0cbc169/src/AlgoliaSearchCore.js#L232-L240
+    if (!client.transporter) {
+      var cacheKey = "/1/indexes/*/queries_body_".concat(JSON.stringify({
+        requests: Object.keys(results).reduce(function (acc, key) {
+          return acc.concat(results[key].rawResults.map(function (request) {
+            return {
+              indexName: request.index,
+              params: request.params
+            };
+          }));
+        }, [])
+      }));
+      client.cache = _objectSpread2(_objectSpread2({}, client.cache), {}, _defineProperty({}, cacheKey, JSON.stringify({
+        results: Object.keys(results).reduce(function (acc, key) {
+          return acc.concat(results[key].rawResults);
+        }, [])
+      })));
+    }
+  }
+
+  // This function is copied from the algoliasearch v4 API Client. If modified,
+  // consider updating it also in `serializeQueryParameters` from `@algolia/transporter`.
+  function serializeQueryParameters(parameters) {
+    var isObjectOrArray = function isObjectOrArray(value) {
+      return Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
+    };
+    var encode = function encode(format) {
+      for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+        args[_key2 - 1] = arguments[_key2];
+      }
+      var i = 0;
+      return format.replace(/%s/g, function () {
+        return encodeURIComponent(args[i++]);
+      });
+    };
+    return Object.keys(parameters).map(function (key) {
+      return encode('%s=%s', key, isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]);
+    }).join('&');
+  }
+
   function isPrimitive(obj) {
     return obj !== Object(obj);
   }
@@ -9911,7 +10019,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.14.2';
+  var version = '3.15.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -12554,7 +12662,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 +12755,7 @@
       return {
         $$type: 'ais.insights',
         $$internal: $$internal,
+        $$automatic: $$automatic,
         onStateChange: function onStateChange() {},
         subscribe: function subscribe() {
           if (!insightsClient.shouldAddScript) return;
@@ -12670,9 +12781,14 @@
             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 +12855,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');
               }
@@ -14626,7 +14745,7 @@
     };
   }
 
-  var version$1 = '4.58.0';
+  var version$1 = '4.60.0';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -14678,6 +14797,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);
       /**
@@ -14728,7 +14848,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,
@@ -14784,6 +14904,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;
@@ -14795,8 +14916,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;
@@ -15051,6 +15173,7 @@
           uiState: this._initialUiState
         });
         if (this._initialResults) {
+          hydrateSearchClient(this.client, this._initialResults);
           var originalScheduleSearch = this.scheduleSearch;
           // We don't schedule a first search when initial results are provided
           // because we already have the results to render. This skips the initial
@@ -15088,6 +15211,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
+              }));
+            }
+          });
+        }
       }
 
       /**
@@ -15117,8 +15258,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();
         });
       }
@@ -17756,6 +17897,7 @@
     searchAsYouType: true,
     isSearchStalled: false,
     disabled: false,
+    ariaLabel: 'Search',
     onChange: noop,
     onSubmit: noop,
     onReset: noop,
@@ -17872,7 +18014,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", {
@@ -17899,7 +18042,8 @@
           maxLength: 512,
           onInput: this.onInput,
           onBlur: this.onBlur,
-          onFocus: this.onFocus
+          onFocus: this.onFocus,
+          "aria-label": ariaLabel
         }), h(Template, {
           templateKey: "submit",
           rootTagName: "button",
@@ -18148,7 +18292,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
@@ -18517,13 +18662,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),
@@ -19183,7 +19330,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,
@@ -19193,7 +19340,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,
@@ -19216,7 +19363,7 @@
         createClickHandler: createClickHandler
       });
     }), props.showNext && h(PaginationLink, {
-      ariaLabel: "Next",
+      ariaLabel: "Next Page",
       className: props.cssClasses.nextPageItem,
       isDisabled: props.isLastPage,
       templates: props.templates,
@@ -19226,7 +19373,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,
@@ -20723,8 +20870,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));
@@ -21646,7 +21795,8 @@
         cssClasses: cssClasses,
         currentValue: currentRefinement,
         options: options,
-        setValue: refine
+        setValue: refine,
+        ariaLabel: "Sort results by"
       })), containerNode);
     };
   };