instantsearch.js 4.33.2 → 4.34.0

package/es/connectors/autocomplete/connectAutocomplete.js

@@ -52,6 +52,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
         var _this = this;
 
         var helper = _ref4.helper,
+            state = _ref4.state,
             scopedResults = _ref4.scopedResults,
             instantSearchInstance = _ref4.instantSearchInstance;
 
@@ -79,7 +80,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
           };
         });
         return {
-          currentRefinement: helper.state.query || '',
+          currentRefinement: state.query || '',
           indices: indices,
           refine: connectorState.refine,
           widgetParams: widgetParams

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

@@ -165,7 +165,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
             index: helper.getIndex(),
             widgetType: this.$$type
           });
-          isFirstPage = helper.state.page === undefined || getFirstReceivedPage(helper.state, cachedHits) === 0;
+          isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
           var _state$page3 = state.page,
               _page = _state$page3 === void 0 ? 0 : _state$page3;

package/es/connectors/pagination/connectPagination.js

@@ -78,6 +78,7 @@ var connectPagination = function connectPagination(renderFn) {
       getWidgetRenderState: function getWidgetRenderState(_ref6) {
         var results = _ref6.results,
             helper = _ref6.helper,
+            state = _ref6.state,
             createURL = _ref6.createURL;
 
         if (!connectorState.refine) {
@@ -88,14 +89,13 @@ var connectPagination = function connectPagination(renderFn) {
         }
 
         if (!connectorState.createURL) {
-          connectorState.createURL = function (state) {
+          connectorState.createURL = function (helperState) {
             return function (page) {
-              return createURL(state.setPage(page));
+              return createURL(helperState.setPage(page));
             };
           };
         }
 
-        var state = helper.state;
         var page = state.page || 0;
         var nbPages = getMaxPage(results || {
           nbPages: 0

package/es/connectors/search-box/connectSearchBox.js

@@ -63,11 +63,12 @@ var connectSearchBox = function connectSearchBox(renderFn) {
       },
       getWidgetRenderState: function getWidgetRenderState(_ref3) {
         var helper = _ref3.helper,
-            searchMetadata = _ref3.searchMetadata;
+            searchMetadata = _ref3.searchMetadata,
+            state = _ref3.state;
 
         if (!_refine) {
           var setQueryAndSearch = function setQueryAndSearch(query) {
-            if (query !== helper.state.query) {
+            if (query !== state.query) {
               helper.setQuery(query).search();
             }
           };
@@ -84,7 +85,7 @@ var connectSearchBox = function connectSearchBox(renderFn) {
 
         _clear = clear(helper);
         return {
-          query: helper.state.query || '',
+          query: state.query || '',
           refine: _refine,
           clear: _cachedClear,
           widgetParams: widgetParams,

package/es/connectors/sort-by/connectSortBy.js

@@ -64,6 +64,7 @@ var connectSortBy = function connectSortBy(renderFn) {
       getWidgetRenderState: function getWidgetRenderState(_ref3) {
         var results = _ref3.results,
             helper = _ref3.helper,
+            state = _ref3.state,
             parent = _ref3.parent;
 
         if (!connectorState.initialIndex && parent) {
@@ -77,7 +78,7 @@ var connectSortBy = function connectSortBy(renderFn) {
         }
 
         return {
-          currentRefinement: helper.state.index,
+          currentRefinement: state.index,
           options: transformItems(items),
           refine: connectorState.setIndex,
           hasNoResults: results ? results.nbHits === 0 : true,

package/es/connectors/stats/connectStats.js

@@ -42,18 +42,18 @@ var connectStats = function connectStats(renderFn) {
       },
       getWidgetRenderState: function getWidgetRenderState(_ref) {
         var results = _ref.results,
-            helper = _ref.helper;
+            state = _ref.state;
 
         if (!results) {
           return {
-            hitsPerPage: helper.state.hitsPerPage,
+            hitsPerPage: state.hitsPerPage,
             nbHits: 0,
             nbSortedHits: undefined,
             areHitsSorted: false,
             nbPages: 0,
-            page: helper.state.page || 0,
+            page: state.page || 0,
             processingTimeMS: -1,
-            query: helper.state.query || '',
+            query: state.query || '',
             widgetParams: widgetParams
           };
         }

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

@@ -177,7 +177,7 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
             createURL = _ref6.createURL,
             instantSearchInstance = _ref6.instantSearchInstance;
         var isRefined = results ? on.every(function (v) {
-          return helper.state.isDisjunctiveFacetRefined(attribute, v);
+          return state.isDisjunctiveFacetRefined(attribute, v);
         }) : on.every(function (v) {
           return state.isDisjunctiveFacetRefined(attribute, v);
         });

package/es/lib/InstantSearch.d.ts

@@ -2,7 +2,7 @@
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import EventEmitter from 'events';
 import type { IndexWidget } from '../widgets/index/index';
-import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState } from '../types';
+import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
 import type { RouterProps } from '../middlewares/createRouterMiddleware';
 import type { InsightsEvent } from '../middlewares/createInsightsMiddleware';
 /**
@@ -106,6 +106,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
     _initialUiState: UiState;
+    _initialResults: InitialResults | null;
     _createURL: CreateURL<UiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];

package/es/lib/InstantSearch.js

@@ -91,6 +91,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
     _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
 
+    _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
+
     _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
 
     _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
@@ -195,6 +197,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _this._isSearchStalled = false;
     _this._createURL = defaultCreateURL;
     _this._initialUiState = initialUiState;
+    _this._initialResults = null;
 
     if (searchFunction) {
       _this._searchFunction = searchFunction;
@@ -437,9 +440,27 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         parent: null,
         uiState: this._initialUiState
       });
-      this.scheduleSearch(); // Keep the previous reference for legacy purpose, some pattern use
+
+      if (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
+        // network request on the browser on `start`.
+
+        this.scheduleSearch = defer(noop); // We also skip the initial network request when widgets are dynamically
+        // added in the first tick (that's the case in all the framework-based flavors).
+        // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
+        // on our `defer` util to restore the original `scheduleSearch` value once
+        // widgets are added to hook back to the regular lifecycle.
+
+        defer(function () {
+          _this3.scheduleSearch = originalScheduleSearch;
+        })();
+      } else {
+        this.scheduleSearch();
+      } // Keep the previous reference for legacy purpose, some pattern use
       // the direct Helper access `search.helper` (e.g multi-index).
 
+
       this.helper = this.mainIndex.getHelper(); // track we started the search if we add more widgets,
       // to init them directly after add
 

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.33.2";
+declare const _default: "4.34.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.33.2';
+export default '4.34.0';

package/es/types/results.d.ts

@@ -1,3 +1,4 @@
+import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
 export declare type HitAttributeHighlightResult = {
     value: string;
     matchLevel: 'none' | 'partial' | 'full';
@@ -64,3 +65,9 @@ export declare type NumericRefinement = {
     operator: string;
 };
 export declare type Refinement = FacetRefinement | NumericRefinement;
+declare type InitialResult = {
+    state: PlainSearchParameters;
+    results: SearchResults['_rawResults'];
+};
+export declare type InitialResults = Record<string, InitialResult>;
+export {};

package/es/widgets/index/index.js

@@ -275,7 +275,8 @@ var index = function index(widgetParams) {
       return this;
     },
     init: function init(_ref2) {
-      var _this3 = this;
+      var _this3 = this,
+          _instantSearchInstanc;
 
       var instantSearchInstance = _ref2.instantSearchInstance,
           parent = _ref2.parent,
@@ -333,11 +334,21 @@ var index = function index(widgetParams) {
 
       derivedHelper = mainHelper.derive(function () {
         return mergeSearchParameters.apply(void 0, _toConsumableArray(resolveSearchParameters(_this3)));
-      }); // Subscribe to the Helper state changes for the page before widgets
+      });
+      var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
+
+      if (indexInitialResults) {
+        // We restore the shape of the results provided to the instance to respect
+        // the helper's structure.
+        var results = new algoliasearchHelper.SearchResults(new algoliasearchHelper.SearchParameters(indexInitialResults.state), indexInitialResults.results);
+        derivedHelper.lastResults = results;
+        helper.lastResults = results;
+      } // Subscribe to the Helper state changes for the page before widgets
       // are initialized. This behavior mimics the original one of the Helper.
       // It makes sense to replicate it at the `init` step. We have another
       // listener on `change` below, once `init` is done.
 
+
       helper.on('change', function (_ref3) {
         var isPageReset = _ref3.isPageReset;
 
@@ -438,6 +449,13 @@ var index = function index(widgetParams) {
           instantSearchInstance.onInternalStateChange();
         }
       });
+
+      if (indexInitialResults) {
+        // If there are initial results, we're not notified of the next results
+        // because we don't trigger an initial search. We therefore need to directly
+        // schedule a render that will render the results injected on the helper.
+        instantSearchInstance.scheduleRender();
+      }
     },
     render: function render(_ref5) {
       var _this4 = this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.33.2",
+  "version": "4.34.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",
@@ -150,7 +150,7 @@
   "bundlesize": [
     {
       "path": "./dist/instantsearch.production.min.js",
-      "maxSize": "69.25 kB"
+      "maxSize": "69.50 kB"
     },
     {
       "path": "./dist/instantsearch.development.js",