instantsearch.js 4.55.0 → 4.56.1

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

@@ -171,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) {
@@ -181,7 +182,21 @@ 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: normalizeState(state),
@@ -206,8 +221,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           widgetParams: widgetParams
         };
       },
-      dispose: function dispose(_ref7) {
-        var state = _ref7.state;
+      dispose: function dispose(_ref8) {
+        var state = _ref8.state;
         unmountFn();
         var stateWithoutPage = state.setQueryParameter('page', undefined);
         if (!escapeHTML) {
@@ -217,8 +232,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, undefined));
         }, {}));
       },
-      getWidgetUiState: function getWidgetUiState(uiState, _ref8) {
-        var searchParameters = _ref8.searchParameters;
+      getWidgetUiState: function getWidgetUiState(uiState, _ref9) {
+        var searchParameters = _ref9.searchParameters;
         var page = searchParameters.page || 0;
         if (!page) {
           // return without adding `page` to uiState
@@ -231,8 +246,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           page: page + 1
         });
       },
-      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref9) {
-        var uiState = _ref9.uiState;
+      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref10) {
+        var uiState = _ref10.uiState;
         var widgetSearchParameters = searchParameters;
         if (escapeHTML) {
           widgetSearchParameters = searchParameters.setQueryParameters(_utils.TAG_PLACEHOLDER);

package/cjs/lib/InstantSearch.js

@@ -107,7 +107,7 @@ 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,
@@ -124,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.'));
     }
@@ -368,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/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).
@@ -45,6 +87,7 @@ var BrowserHistory = /*#__PURE__*/function () {
     _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);
@@ -150,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/utils/escape-highlight.js

@@ -25,6 +25,8 @@ var TAG_REPLACEMENT = {
   highlightPreTag: '<mark>',
   highlightPostTag: '</mark>'
 };
+
+// @MAJOR: in the future, this should only escape, not replace
 exports.TAG_REPLACEMENT = TAG_REPLACEMENT;
 function replaceTagsAndEscape(value) {
   return (0, _escapeHtml.escape)(value).replace(new RegExp(TAG_PLACEHOLDER.highlightPreTag, 'g'), TAG_REPLACEMENT.highlightPreTag).replace(new RegExp(TAG_PLACEHOLDER.highlightPostTag, 'g'), TAG_REPLACEMENT.highlightPostTag);

package/cjs/lib/utils/getHighlightedParts.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getHighlightedParts = getHighlightedParts;
 var _escapeHighlight = require("./escape-highlight");
 function getHighlightedParts(highlightedValue) {
+  // @MAJOR: this should use TAG_PLACEHOLDER
   var highlightPostTag = _escapeHighlight.TAG_REPLACEMENT.highlightPostTag,
     highlightPreTag = _escapeHighlight.TAG_REPLACEMENT.highlightPreTag;
   var splitByPreTag = highlightedValue.split(highlightPreTag);

package/cjs/lib/utils/render-args.js

@@ -26,13 +26,14 @@ function createInitArgs(instantSearchInstance, parent, uiState) {
 }
 function createRenderArgs(instantSearchInstance, parent) {
   var results = parent.getResults();
+  var helper = parent.getHelper();
   return {
-    helper: parent.getHelper(),
+    helper: helper,
     parent: parent,
     instantSearchInstance: instantSearchInstance,
     results: results,
     scopedResults: parent.getScopedResults(),
-    state: results._state,
+    state: results ? results._state : helper.state,
     renderState: instantSearchInstance.renderState,
     templatesConfig: instantSearchInstance.templatesConfig,
     createURL: parent.createURL,

package/cjs/lib/version.js

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

package/cjs/widgets/hits-per-page/hits-per-page.js

@@ -38,7 +38,9 @@ var renderer = function renderer(_ref) {
     }, (0, _preact.h)(_Selector.default, {
       cssClasses: cssClasses,
       currentValue: currentValue,
-      options: items,
+      options: items
+      // @ts-expect-error: the refine function expects a number, but setValue will call it with a string. We don't want to change the type of the refine function because it's part of the connector API.
+      ,
       setValue: refine
     })), containerNode);
   };

package/cjs/widgets/index/index.js

@@ -339,7 +339,7 @@ var index = function index(widgetParams) {
         // does not have access to lastResults, which it used to in pre-federated
         // search behavior.
         helper.lastResults = results;
-        lastValidSearchParameters = results._state;
+        lastValidSearchParameters = results === null || results === void 0 ? void 0 : results._state;
       });
 
       // We compute the render state before calling `init` in a separate loop
@@ -395,16 +395,16 @@ var index = function index(widgetParams) {
     render: function render(_ref5) {
       var _this4 = this;
       var instantSearchInstance = _ref5.instantSearchInstance;
-      if (!this.getResults()) {
-        return;
-      }
-
       // we can't attach a listener to the error event of search, as the error
       // then would no longer be thrown for global handlers.
-      if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests()) {
+      if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests() && lastValidSearchParameters) {
         helper.setState(lastValidSearchParameters);
       }
-      localWidgets.forEach(function (widget) {
+
+      // We only render index widgets if there are no results.
+      // This makes sure `render` is never called with `results` being `null`.
+      var widgetsToRender = this.getResults() ? localWidgets : localWidgets.filter(_utils.isIndexWidget);
+      widgetsToRender.forEach(function (widget) {
         if (widget.getRenderState) {
           var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, (0, _utils.createRenderArgs)(instantSearchInstance, _this4));
           storeRenderState({
@@ -414,7 +414,7 @@ var index = function index(widgetParams) {
           });
         }
       });
-      localWidgets.forEach(function (widget) {
+      widgetsToRender.forEach(function (widget) {
         // At this point, all the variables used below are set. Both `helper`
         // and `derivedHelper` have been created at the `init` step. The attribute
         // `lastResults` might be `null` though. It's possible that a stalled render