instantsearch.js 4.54.1 → 4.56.0

package/cjs/connectors/geo-search/connectGeoSearch.js

@@ -137,7 +137,7 @@ var connectGeoSearch = function connectGeoSearch(renderFn) {
         widgetState.internalToggleRefineOnMapMove = createInternalToggleRefinementOnMapMove(renderArgs, this.render.bind(this));
         widgetState.internalSetMapMoveSinceLastRefine = createInternalSetMapMoveSinceLastRefine(renderArgs, this.render.bind(this));
         var widgetRenderState = this.getWidgetRenderState(renderArgs);
-        sendEvent('view', widgetRenderState.items);
+        sendEvent('view:internal', widgetRenderState.items);
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), isFirstRendering);

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

@@ -161,7 +161,7 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
         }
         if (!_refine) {
           _refine = function _refine(facetValue) {
-            sendEvent('click', facetValue);
+            sendEvent('click:internal', facetValue);
             helper.toggleFacetRefinement(hierarchicalFacetName, facetValue).search();
           };
         }

package/cjs/connectors/hits/connectHits.js

@@ -40,7 +40,7 @@ var connectHits = function connectHits(renderFn) {
         renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
           instantSearchInstance: renderOptions.instantSearchInstance
         }), false);
-        renderState.sendEvent('view', renderState.hits);
+        renderState.sendEvent('view:internal', renderState.hits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -6,7 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-var _excluded = ["page"];
+var _excluded = ["page"],
+  _excluded2 = ["clickAnalytics", "userToken"];
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -30,17 +31,24 @@ function getStateWithoutPage(state) {
     rest = _objectWithoutProperties(_ref, _excluded);
   return rest;
 }
+function normalizeState(state) {
+  var _ref2 = state || {},
+    clickAnalytics = _ref2.clickAnalytics,
+    userToken = _ref2.userToken,
+    rest = _objectWithoutProperties(_ref2, _excluded2);
+  return rest;
+}
 function getInMemoryCache() {
   var cachedHits = null;
   var cachedState = null;
   return {
-    read: function read(_ref2) {
-      var state = _ref2.state;
+    read: function read(_ref3) {
+      var state = _ref3.state;
       return (0, _utils.isEqual)(cachedState, getStateWithoutPage(state)) ? cachedHits : null;
     },
-    write: function write(_ref3) {
-      var state = _ref3.state,
-        hits = _ref3.hits;
+    write: function write(_ref4) {
+      var state = _ref4.state,
+        hits = _ref4.hits;
       cachedState = getStateWithoutPage(state);
       cachedHits = hits;
     }
@@ -60,15 +68,15 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
   // @TODO: this should be a generic, but a Connector can not yet be generic itself
 
   return function (widgetParams) {
-    var _ref4 = widgetParams || {},
-      _ref4$escapeHTML = _ref4.escapeHTML,
-      escapeHTML = _ref4$escapeHTML === void 0 ? true : _ref4$escapeHTML,
-      _ref4$transformItems = _ref4.transformItems,
-      transformItems = _ref4$transformItems === void 0 ? function (items) {
+    var _ref5 = widgetParams || {},
+      _ref5$escapeHTML = _ref5.escapeHTML,
+      escapeHTML = _ref5$escapeHTML === void 0 ? true : _ref5$escapeHTML,
+      _ref5$transformItems = _ref5.transformItems,
+      transformItems = _ref5$transformItems === void 0 ? function (items) {
         return items;
-      } : _ref4$transformItems,
-      _ref4$cache = _ref4.cache,
-      cache = _ref4$cache === void 0 ? getInMemoryCache() : _ref4$cache;
+      } : _ref5$transformItems,
+      _ref5$cache = _ref5.cache,
+      cache = _ref5$cache === void 0 ? getInMemoryCache() : _ref5$cache;
     var showPrevious;
     var showMore;
     var sendEvent;
@@ -99,7 +107,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         // avoid updating the browser URL when the user displays the previous page.
         helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
           page: getFirstReceivedPage(helper.state, cache.read({
-            state: helper.state
+            state: normalizeState(helper.state)
           }) || {}) - 1
         })).searchWithoutTriggeringOnStateChange();
       };
@@ -107,7 +115,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
     var getShowMore = function getShowMore(helper) {
       return function () {
         helper.setPage(getLastReceivedPage(helper.state, cache.read({
-          state: helper.state
+          state: normalizeState(helper.state)
         }) || {}) + 1).search();
       };
     };
@@ -124,19 +132,19 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), false);
-        sendEvent('view', widgetRenderState.currentPageHits);
+        sendEvent('view:internal', widgetRenderState.currentPageHits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {
           infiniteHits: this.getWidgetRenderState(renderOptions)
         });
       },
-      getWidgetRenderState: function getWidgetRenderState(_ref5) {
-        var results = _ref5.results,
-          helper = _ref5.helper,
-          parent = _ref5.parent,
-          existingState = _ref5.state,
-          instantSearchInstance = _ref5.instantSearchInstance;
+      getWidgetRenderState: function getWidgetRenderState(_ref6) {
+        var results = _ref6.results,
+          helper = _ref6.helper,
+          parent = _ref6.parent,
+          existingState = _ref6.state,
+          instantSearchInstance = _ref6.instantSearchInstance;
         var isFirstPage;
         var currentPageHits = [];
         /**
@@ -146,7 +154,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
          */
         var state = parent.getPreviousState() || existingState;
         var cachedHits = cache.read({
-          state: state
+          state: normalizeState(state)
         }) || {};
         if (!results) {
           showPrevious = getShowPrevious(helper);
@@ -163,6 +171,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           });
           isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
+          var _results$disjunctiveF, _results$facets, _results$hierarchical;
           var _state$page3 = state.page,
             _page = _state$page3 === void 0 ? 0 : _state$page3;
           if (escapeHTML && results.hits.length > 0) {
@@ -173,10 +182,24 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
             results: results
           });
-          if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle') {
+
+          /*
+            With dynamic widgets, facets are not included in the state before their relevant widgets are mounted. Until then, we need to bail out of writing this incomplete state representation in cache.
+          */
+          var hasDynamicWidgets = false;
+          (0, _utils.walkIndex)(instantSearchInstance.mainIndex, function (indexWidget) {
+            if (!hasDynamicWidgets && indexWidget.getWidgets().some(function (_ref7) {
+              var $$type = _ref7.$$type;
+              return $$type === 'ais.dynamicWidgets';
+            })) {
+              hasDynamicWidgets = true;
+            }
+          });
+          var hasNoFacets = !((_results$disjunctiveF = results.disjunctiveFacets) !== null && _results$disjunctiveF !== void 0 && _results$disjunctiveF.length) && !((_results$facets = results.facets) !== null && _results$facets !== void 0 && _results$facets.length) && !((_results$hierarchical = results.hierarchicalFacets) !== null && _results$hierarchical !== void 0 && _results$hierarchical.length);
+          if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle' && !(hasDynamicWidgets && hasNoFacets)) {
             cachedHits[_page] = transformedHits;
             cache.write({
-              state: state,
+              state: normalizeState(state),
               hits: cachedHits
             });
           }
@@ -198,8 +221,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           widgetParams: widgetParams
         };
       },
-      dispose: function dispose(_ref6) {
-        var state = _ref6.state;
+      dispose: function dispose(_ref8) {
+        var state = _ref8.state;
         unmountFn();
         var stateWithoutPage = state.setQueryParameter('page', undefined);
         if (!escapeHTML) {
@@ -209,8 +232,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, undefined));
         }, {}));
       },
-      getWidgetUiState: function getWidgetUiState(uiState, _ref7) {
-        var searchParameters = _ref7.searchParameters;
+      getWidgetUiState: function getWidgetUiState(uiState, _ref9) {
+        var searchParameters = _ref9.searchParameters;
         var page = searchParameters.page || 0;
         if (!page) {
           // return without adding `page` to uiState
@@ -223,8 +246,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           page: page + 1
         });
       },
-      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
-        var uiState = _ref8.uiState;
+      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref10) {
+        var uiState = _ref10.uiState;
         var widgetSearchParameters = searchParameters;
         if (escapeHTML) {
           widgetSearchParameters = searchParameters.setQueryParameters(_utils.TAG_PLACEHOLDER);

package/cjs/connectors/menu/connectMenu.js

@@ -127,7 +127,7 @@ var connectMenu = function connectMenu(renderFn) {
             var _helper$getHierarchic = helper.getHierarchicalFacetBreadcrumb(attribute),
               _helper$getHierarchic2 = _slicedToArray(_helper$getHierarchic, 1),
               refinedItem = _helper$getHierarchic2[0];
-            sendEvent('click', facetValue ? facetValue : refinedItem);
+            sendEvent('click:internal', facetValue ? facetValue : refinedItem);
             helper.toggleFacetRefinement(attribute, facetValue ? facetValue : refinedItem).search();
           };
         }

package/cjs/connectors/numeric-menu/connectNumericMenu.js

@@ -143,7 +143,7 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         if (!connectorState.refine) {
           connectorState.refine = function (facetValue) {
             var refinedState = getRefinedState(helper.state, attribute, facetValue);
-            connectorState.sendEvent('click', facetValue);
+            connectorState.sendEvent('click:internal', facetValue);
             helper.setState(refinedState).search();
           };
         }

package/cjs/connectors/rating-menu/connectRatingMenu.js

@@ -41,10 +41,13 @@ var createSendEvent = function createSendEvent(_ref) {
       instantSearchInstance.sendEventToInsights(args[0]);
       return;
     }
-    var eventType = args[0],
-      facetValue = args[1],
+    var facetValue = args[1],
       _args$ = args[2],
       eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
+    var _args$0$split = args[0].split(':'),
+      _args$0$split2 = _slicedToArray(_args$0$split, 2),
+      eventType = _args$0$split2[0],
+      eventModifier = _args$0$split2[1];
     if (eventType !== 'click') {
       return;
     }
@@ -54,6 +57,7 @@ var createSendEvent = function createSendEvent(_ref) {
         insightsMethod: 'clickedFilters',
         widgetType: $$type,
         eventType: eventType,
+        eventModifier: eventModifier,
         payload: {
           eventName: eventName,
           index: helper.getIndex(),
@@ -129,7 +133,7 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
       return emptyState;
     }
     var toggleRefinement = function toggleRefinement(helper, facetValue) {
-      sendEvent('click', facetValue);
+      sendEvent('click:internal', facetValue);
       helper.setState(getRefinedState(helper.state, facetValue)).search();
     };
     var connectorState = {

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

@@ -178,7 +178,7 @@ var connectRefinementList = function connectRefinementList(renderFn) {
             widgetType: this.$$type
           });
           triggerRefine = function triggerRefine(facetValue) {
-            sendEvent('click', facetValue);
+            sendEvent('click:internal', facetValue);
             helper.toggleFacetRefinement(attribute, facetValue).search();
           };
           searchForFacetValues = createSearchForFacetValues(helper, this);

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

@@ -1,16 +1,22 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 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 _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 var withUsage = (0, _utils.createDocumentationMessageGenerator)({
   name: 'toggle-refinement',
   connector: true
@@ -29,10 +35,13 @@ var createSendEvent = function createSendEvent(_ref) {
       instantSearchInstance.sendEventToInsights(args[0]);
       return;
     }
-    var eventType = args[0],
-      isRefined = args[1],
+    var isRefined = args[1],
       _args$ = args[2],
       eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
+    var _args$0$split = args[0].split(':'),
+      _args$0$split2 = _slicedToArray(_args$0$split, 2),
+      eventType = _args$0$split2[0],
+      eventModifier = _args$0$split2[1];
     if (eventType !== 'click' || on === undefined) {
       return;
     }
@@ -44,6 +53,7 @@ var createSendEvent = function createSendEvent(_ref) {
         insightsMethod: 'clickedFilters',
         widgetType: $$type,
         eventType: eventType,
+        eventModifier: eventModifier,
         payload: {
           eventName: eventName,
           index: helper.getIndex(),
@@ -90,7 +100,7 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           },
           isRefined = _ref3.isRefined;
         if (!isRefined) {
-          sendEvent('click', isRefined);
+          sendEvent('click:internal', isRefined);
           if (hasAnOffValue) {
             off.forEach(function (v) {
               return helper.removeDisjunctiveFacetRefinement(attribute, v);

package/cjs/helpers/insights.js

@@ -4,11 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = insights;
-exports.hasDataAttributes = hasDataAttributes;
 exports.readDataAttributes = readDataAttributes;
 exports.writeDataAttributes = writeDataAttributes;
 var _utils = require("../lib/utils");
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+/** @deprecated use bindEvent instead */
 function readDataAttributes(domElement) {
   var method = domElement.getAttribute('data-insights-method');
   var serializedPayload = domElement.getAttribute('data-insights-payload');
@@ -25,9 +25,8 @@ function readDataAttributes(domElement) {
     throw new Error('The insights helper was unable to parse `data-insights-payload`.');
   }
 }
-function hasDataAttributes(domElement) {
-  return domElement.hasAttribute('data-insights-method');
-}
+
+/** @deprecated use bindEvent instead */
 function writeDataAttributes(_ref) {
   var method = _ref.method,
     payload = _ref.payload;

package/cjs/lib/InstantSearch.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _events = _interopRequireDefault(require("@algolia/events"));
 var _algoliasearchHelper = _interopRequireDefault(require("algoliasearch-helper"));
+var _createInsightsMiddleware = require("../middlewares/createInsightsMiddleware");
 var _createMetadataMiddleware = require("../middlewares/createMetadataMiddleware");
 var _createRouterMiddleware = require("../middlewares/createRouterMiddleware");
 var _index = _interopRequireDefault(require("../widgets/index/index"));
@@ -106,12 +107,14 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     }));
     _this.setMaxListeners(100);
     var _options$indexName = options.indexName,
-      indexName = _options$indexName === void 0 ? null : _options$indexName,
+      indexName = _options$indexName === void 0 ? '' : _options$indexName,
       numberLocale = options.numberLocale,
       _options$initialUiSta = options.initialUiState,
       initialUiState = _options$initialUiSta === void 0 ? {} : _options$initialUiSta,
       _options$routing = options.routing,
       routing = _options$routing === void 0 ? null : _options$routing,
+      _options$insights = options.insights,
+      insights = _options$insights === void 0 ? false : _options$insights,
       searchFunction = options.searchFunction,
       _options$stalledSearc = options.stalledSearchDelay,
       stalledSearchDelay = _options$stalledSearc === void 0 ? 200 : _options$stalledSearc,
@@ -121,9 +124,6 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       insightsClient = _options$insightsClie === void 0 ? null : _options$insightsClie,
       _options$onStateChang = options.onStateChange,
       onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang;
-    if (indexName === null) {
-      throw new Error(withUsage('The `indexName` option is required.'));
-    }
     if (searchClient === null) {
       throw new Error(withUsage('The `searchClient` option is required.'));
     }
@@ -167,11 +167,22 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     }
     _this.sendEventToInsights = _utils.noop;
     if (routing) {
-      var routerOptions = typeof routing === 'boolean' ? undefined : routing;
+      var routerOptions = typeof routing === 'boolean' ? {} : routing;
+      routerOptions.$$internal = true;
       _this.use((0, _createRouterMiddleware.createRouterMiddleware)(routerOptions));
     }
+
+    // This is the default middleware,
+    // any user-provided middleware will be added later and override this one.
+    if (insights) {
+      var insightsOptions = typeof insights === 'boolean' ? {} : insights;
+      insightsOptions.$$internal = true;
+      _this.use((0, _createInsightsMiddleware.createInsightsMiddleware)(insightsOptions));
+    }
     if ((0, _createMetadataMiddleware.isMetadataEnabled)()) {
-      _this.use((0, _createMetadataMiddleware.createMetadataMiddleware)());
+      _this.use((0, _createMetadataMiddleware.createMetadataMiddleware)({
+        $$internal: true
+      }));
     }
     return _this;
   }
@@ -207,6 +218,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       }
       var newMiddlewareList = middleware.map(function (fn) {
         var newMiddleware = _objectSpread({
+          $$type: '__unknown__',
+          $$internal: false,
           subscribe: _utils.noop,
           started: _utils.noop,
           unsubscribe: _utils.noop,
@@ -352,6 +365,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       mainHelper.search = function () {
         _this3.status = 'loading';
         _this3.scheduleRender(false);
+        process.env.NODE_ENV === 'development' ? (0, _utils.warning)(Boolean(_this3.indexName) || _this3.mainIndex.getWidgets().some(_utils.isIndexWidget), 'No indexName provided, nor an explicit index widget in the widgets tree. This is required to be able to display results.') : void 0;
 
         // This solution allows us to keep the exact same API for the users but
         // under the hood, we have a different implementation. It should be

package/cjs/lib/insights/listener.js

@@ -3,11 +3,40 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.createInsightsEventHandler = void 0;
+exports.default = withInsightsListener;
 var _preact = require("preact");
 var _insights = require("../../helpers/insights");
 var _utils = require("../utils");
-var findInsightsTarget = function findInsightsTarget(startElement, endElement, validator) {
+var createInsightsEventHandler = function createInsightsEventHandler(_ref) {
+  var insights = _ref.insights,
+    sendEvent = _ref.sendEvent;
+  return function (event) {
+    // new way, e.g. bindEvent("click", hit, "Hit clicked")
+    var insightsThroughSendEvent = findInsightsTarget(event.target, event.currentTarget, function (element) {
+      return element.hasAttribute('data-insights-event');
+    });
+    if (insightsThroughSendEvent) {
+      var payload = parseInsightsEvent(insightsThroughSendEvent);
+      payload.forEach(function (single) {
+        return sendEvent(single);
+      });
+    }
+
+    // old way, e.g. instantsearch.insights("clickedObjectIDsAfterSearch", { .. })
+    var insightsThroughFunction = findInsightsTarget(event.target, event.currentTarget, function (element) {
+      return element.hasAttribute('data-insights-method') && element.hasAttribute('data-insights-payload');
+    });
+    if (insightsThroughFunction) {
+      var _readDataAttributes = (0, _insights.readDataAttributes)(insightsThroughFunction),
+        method = _readDataAttributes.method,
+        _payload = _readDataAttributes.payload;
+      insights(method, _payload);
+    }
+  };
+};
+exports.createInsightsEventHandler = createInsightsEventHandler;
+function findInsightsTarget(startElement, endElement, validator) {
   var element = startElement;
   while (element && !validator(element)) {
     if (element === endElement) {
@@ -16,8 +45,8 @@ var findInsightsTarget = function findInsightsTarget(startElement, endElement, v
     element = element.parentElement;
   }
   return element;
-};
-var parseInsightsEvent = function parseInsightsEvent(element) {
+}
+function parseInsightsEvent(element) {
   var serializedPayload = element.getAttribute('data-insights-event');
   if (typeof serializedPayload !== 'string') {
     throw new Error('The insights middleware expects `data-insights-event` to be a base64-encoded JSON string.');
@@ -27,39 +56,17 @@ var parseInsightsEvent = function parseInsightsEvent(element) {
   } catch (error) {
     throw new Error('The insights middleware was unable to parse `data-insights-event`.');
   }
-};
-var insightsListener = function insightsListener(BaseComponent) {
-  function WithInsightsListener(props) {
-    var handleClick = function handleClick(event) {
-      if (props.sendEvent) {
-        // new way with insights middleware
-        var targetWithEvent = findInsightsTarget(event.target, event.currentTarget, function (element) {
-          return element.hasAttribute('data-insights-event');
-        });
-        if (targetWithEvent) {
-          var payload = parseInsightsEvent(targetWithEvent);
-          payload.forEach(function (single) {
-            return props.sendEvent(single);
-          });
-        }
-      }
+}
 
-      // old way, e.g. instantsearch.insights("clickedObjectIDsAfterSearch", { .. })
-      var insightsTarget = findInsightsTarget(event.target, event.currentTarget, function (element) {
-        return (0, _insights.hasDataAttributes)(element);
-      });
-      if (insightsTarget) {
-        var _readDataAttributes = (0, _insights.readDataAttributes)(insightsTarget),
-          method = _readDataAttributes.method,
-          _payload = _readDataAttributes.payload;
-        props.insights(method, _payload);
-      }
-    };
+/**
+ * @deprecated use `sendEvent` directly instead
+ */
+function withInsightsListener(BaseComponent) {
+  process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, 'The `withInsightsListener` function is deprecated and will be removed in the next major version. Please use `sendEvent` directly instead.') : void 0;
+  return function WithInsightsListener(props) {
+    var handleClick = createInsightsEventHandler(props);
     return (0, _preact.h)("div", {
       onClick: handleClick
     }, (0, _preact.h)(BaseComponent, props));
-  }
-  return WithInsightsListener;
-};
-var _default = insightsListener;
-exports.default = _default;
+  };
+}

package/cjs/lib/routers/history.js

@@ -22,6 +22,48 @@ var setWindowTitle = function setWindowTitle(title) {
   }
 };
 var BrowserHistory = /*#__PURE__*/function () {
+  /**
+   * Transforms a UI state into a title for the page.
+   */
+
+  /**
+   * Time in milliseconds before performing a write in the history.
+   * It prevents from adding too many entries in the history and
+   * makes the back button more usable.
+   *
+   * @default 400
+   */
+
+  /**
+   * Creates a full URL based on the route state.
+   * The storage adaptor maps all syncable keys to the query string of the URL.
+   */
+
+  /**
+   * Parses the URL into a route state.
+   * It should be symmetrical to `createURL`.
+   */
+
+  /**
+   * Returns the location to store in the history.
+   * @default () => window.location
+   */
+
+  /**
+   * Indicates if last action was back/forward in the browser.
+   */
+
+  /**
+   * Indicates whether the history router is disposed or not.
+   */
+
+  /**
+   * Indicates the window.history.length before the last call to
+   * window.history.pushState (called in `write`).
+   * It allows to determine if a `pushState` has been triggered elsewhere,
+   * and thus to prevent the `write` method from calling `pushState`.
+   */
+
   /**
    * Initializes a new storage provider that syncs the search state to the URL
    * using web APIs (`window.location.pushState` and `onpopstate` event).
@@ -38,12 +80,14 @@ var BrowserHistory = /*#__PURE__*/function () {
       dispose = _ref.dispose,
       push = _ref.push;
     _classCallCheck(this, BrowserHistory);
+    _defineProperty(this, "$$type", 'ais.browser');
     _defineProperty(this, "windowTitle", void 0);
     _defineProperty(this, "writeDelay", void 0);
     _defineProperty(this, "_createURL", void 0);
     _defineProperty(this, "parseURL", void 0);
     _defineProperty(this, "getLocation", void 0);
     _defineProperty(this, "writeTimer", void 0);
+    _defineProperty(this, "_onPopState", void 0);
     _defineProperty(this, "inPopState", false);
     _defineProperty(this, "isDisposed", false);
     _defineProperty(this, "latestAcknowledgedHistory", 0);
@@ -149,11 +193,21 @@ var BrowserHistory = /*#__PURE__*/function () {
   }, {
     key: "createURL",
     value: function createURL(routeState) {
-      return this._createURL({
+      var url = this._createURL({
         qsModule: _qs.default,
         routeState: routeState,
         location: this.getLocation()
       });
+      if (process.env.NODE_ENV === 'development') {
+        try {
+          // We just want to check if the URL is valid.
+          // eslint-disable-next-line no-new
+          new URL(url);
+        } catch (e) {
+          process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "The URL returned by the `createURL` function is invalid.\nPlease make sure it returns an absolute URL to avoid issues, e.g: `https://algolia.com/search?query=iphone`.") : void 0;
+        }
+      }
+      return url;
     }
 
     /**

package/cjs/lib/stateMappings/simple.js

@@ -24,6 +24,7 @@ function getIndexStateWithoutConfigure(uiState) {
 // which excludes "configure" as this function does.
 function simpleStateMapping() {
   return {
+    $$type: 'ais.simple',
     stateToRoute: function stateToRoute(uiState) {
       return Object.keys(uiState).reduce(function (state, indexId) {
         return _objectSpread(_objectSpread({}, state), {}, _defineProperty({}, indexId, getIndexStateWithoutConfigure(uiState[indexId])));

package/cjs/lib/stateMappings/singleIndex.js

@@ -18,6 +18,7 @@ function getIndexStateWithoutConfigure(uiState) {
 }
 function singleIndexStateMapping(indexName) {
   return {
+    $$type: 'ais.singleIndex',
     stateToRoute: function stateToRoute(uiState) {
       return getIndexStateWithoutConfigure(uiState[indexName] || {});
     },