instantsearch.js 4.40.4 → 4.41.0

package/es/lib/InstantSearch.js

@@ -460,9 +460,17 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         defer(function () {
           _this3.scheduleSearch = originalScheduleSearch;
         })();
-      } else {
-        this.scheduleSearch();
-      } // Keep the previous reference for legacy purpose, some pattern use
+      } // We only schedule a search when widgets have been added before `start()`
+      // because there are listeners that can use these results.
+      // This is especially useful in framework-based flavors that wait for
+      // dynamically-added widgets to trigger a network request. It avoids
+      // having to batch this initial network request with the one coming from
+      // `addWidgets()`.
+      // Later, we could also skip `index()` widgets and widgets that don't read
+      // the results, but this is an optimization that has a very low impact for now.
+      else if (this.mainIndex.getWidgets().length > 0) {
+          this.scheduleSearch();
+        } // Keep the previous reference for legacy purpose, some pattern use
       // the direct Helper access `search.helper` (e.g multi-index).
 
 

package/es/lib/routers/history.d.ts

@@ -47,10 +47,9 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     private writeTimer?;
     private _onPopState;
     /**
-     * Indicates if history.pushState should be executed.
-     * It needs to avoid pushing state to history in case of back/forward in browser
+     * Indicates if last action was back/forward in the browser.
      */
-    private shouldPushState;
+    private inPopState;
     /**
      * Indicates whether the history router is disposed or not.
      */
@@ -92,6 +91,7 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * Removes the event listener and cleans up the URL.
      */
     dispose(): void;
+    private shouldWrite;
 }
 export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 export {};

package/es/lib/routers/history.js

@@ -46,7 +46,7 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "writeTimer", void 0);
 
-    _defineProperty(this, "shouldPushState", true);
+    _defineProperty(this, "inPopState", false);
 
     _defineProperty(this, "isDisposed", false);
 
@@ -101,20 +101,14 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
 
         _this2.writeTimer = setTimeout(function () {
-          setWindowTitle(title); // We do want to `pushState` if:
-          // - the router is not disposed, IS.js needs to update the URL
-          // OR
-          // - the last write was from InstantSearch.js
-          // (unlike a SPA, where it would have last written)
+          setWindowTitle(title);
 
-          var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
-
-          if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
+          if (_this2.shouldWrite(url)) {
             window.history.pushState(routeState, title || '', url);
             _this2.latestAcknowledgedHistory = window.history.length;
           }
 
-          _this2.shouldPushState = true;
+          _this2.inPopState = false;
           _this2.writeTimer = undefined;
         }, _this2.writeDelay);
       });
@@ -135,7 +129,7 @@ var BrowserHistory = /*#__PURE__*/function () {
           _this3.writeTimer = undefined;
         }
 
-        _this3.shouldPushState = false;
+        _this3.inPopState = true;
         var routeState = event.state; // At initial load, the state is read from the URL without update.
         // Therefore the state object is not available.
         // In this case, we fallback and read the URL.
@@ -193,18 +187,39 @@ var BrowserHistory = /*#__PURE__*/function () {
 
       this.write({});
     }
+  }, {
+    key: "shouldWrite",
+    value: function shouldWrite(url) {
+      var _this5 = this;
+
+      return safelyRunOnBrowser(function (_ref6) {
+        var window = _ref6.window;
+        // We do want to `pushState` if:
+        // - the router is not disposed, IS.js needs to update the URL
+        // OR
+        // - the last write was from InstantSearch.js
+        // (unlike a SPA, where it would have last written)
+        var lastPushWasByISAfterDispose = !(_this5.isDisposed && _this5.latestAcknowledgedHistory !== window.history.length);
+        return (// When the last state change was through popstate, the IS.js state changes,
+          // but that should not write the URL.
+          !_this5.inPopState && // When the previous pushState after dispose was by IS.js, we want to write the URL.
+          lastPushWasByISAfterDispose && // When the URL is the same as the current one, we do not want to write it.
+          url !== window.location.href
+        );
+      });
+    }
   }]);
 
   return BrowserHistory;
 }();
 
 export default function historyRouter() {
-  var _ref6 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      _ref6$createURL = _ref6.createURL,
-      createURL = _ref6$createURL === void 0 ? function (_ref7) {
-    var qsModule = _ref7.qsModule,
-        routeState = _ref7.routeState,
-        location = _ref7.location;
+  var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+      _ref7$createURL = _ref7.createURL,
+      createURL = _ref7$createURL === void 0 ? function (_ref8) {
+    var qsModule = _ref8.qsModule,
+        routeState = _ref8.routeState,
+        location = _ref8.location;
     var protocol = location.protocol,
         hostname = location.hostname,
         _location$port = location.port,
@@ -220,11 +235,11 @@ export default function historyRouter() {
     }
 
     return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-  } : _ref6$createURL,
-      _ref6$parseURL = _ref6.parseURL,
-      parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
-    var qsModule = _ref8.qsModule,
-        location = _ref8.location;
+  } : _ref7$createURL,
+      _ref7$parseURL = _ref7.parseURL,
+      parseURL = _ref7$parseURL === void 0 ? function (_ref9) {
+    var qsModule = _ref9.qsModule,
+        location = _ref9.location;
     // `qs` by default converts arrays with more than 20 items to an object.
     // We want to avoid this because the data structure manipulated can therefore vary.
     // Setting the limit to `100` seems a good number because the engine's default is 100
@@ -238,21 +253,21 @@ export default function historyRouter() {
     return qsModule.parse(location.search.slice(1), {
       arrayLimit: 99
     });
-  } : _ref6$parseURL,
-      _ref6$writeDelay = _ref6.writeDelay,
-      writeDelay = _ref6$writeDelay === void 0 ? 400 : _ref6$writeDelay,
-      windowTitle = _ref6.windowTitle,
-      _ref6$getLocation = _ref6.getLocation,
-      getLocation = _ref6$getLocation === void 0 ? function () {
-    return safelyRunOnBrowser(function (_ref9) {
-      var window = _ref9.window;
+  } : _ref7$parseURL,
+      _ref7$writeDelay = _ref7.writeDelay,
+      writeDelay = _ref7$writeDelay === void 0 ? 400 : _ref7$writeDelay,
+      windowTitle = _ref7.windowTitle,
+      _ref7$getLocation = _ref7.getLocation,
+      getLocation = _ref7$getLocation === void 0 ? function () {
+    return safelyRunOnBrowser(function (_ref10) {
+      var window = _ref10.window;
       return window.location;
     }, {
       fallback: function fallback() {
         throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
       }
     });
-  } : _ref6$getLocation;
+  } : _ref7$getLocation;
 
   return new BrowserHistory({
     createURL: createURL,

package/es/lib/utils/getAppIdAndApiKey.d.ts

@@ -1 +1 @@
-export declare function getAppIdAndApiKey(searchClient: any): any[];
+export declare function getAppIdAndApiKey(searchClient: any): [string, string];

package/es/lib/utils/safelyRunOnBrowser.d.ts

@@ -8,7 +8,7 @@ declare type SafelyRunOnBrowserOptions<TReturn> = {
     fallback: () => TReturn;
 };
 /**
- * Runs code on browser enviromnents safely.
+ * Runs code on browser environments safely.
  */
 export declare function safelyRunOnBrowser<TReturn>(callback: BrowserCallback<TReturn>, { fallback }?: SafelyRunOnBrowserOptions<TReturn>): TReturn;
 export {};

package/es/lib/utils/safelyRunOnBrowser.js

@@ -1,7 +1,7 @@
 // eslint-disable-next-line no-restricted-globals
 
 /**
- * Runs code on browser enviromnents safely.
+ * Runs code on browser environments safely.
  */
 export function safelyRunOnBrowser(callback) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.40.4";
+declare const _default: "4.41.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.40.4';
+export default '4.41.0';

package/es/types/widget.d.ts

@@ -11,7 +11,7 @@ export declare type ScopedResult = {
 };
 declare type SharedRenderOptions = {
     instantSearchInstance: InstantSearch;
-    parent: IndexWidget | null;
+    parent: IndexWidget;
     templatesConfig: Record<string, unknown>;
     scopedResults: ScopedResult[];
     state: SearchParameters;

package/es/widgets/index/index.d.ts

@@ -1,11 +1,17 @@
 import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
-import type { UiState, IndexUiState, Widget, InitOptions, RenderOptions, ScopedResult } from '../../types';
+import type { InstantSearch, UiState, IndexUiState, Widget, ScopedResult } from '../../types';
 export declare type IndexWidgetParams = {
     indexName: string;
     indexId?: string;
 };
-declare type IndexInitOptions = Pick<InitOptions, 'instantSearchInstance' | 'parent' | 'uiState'>;
-declare type IndexRenderOptions = Pick<RenderOptions, 'instantSearchInstance'>;
+export declare type IndexInitOptions = {
+    instantSearchInstance: InstantSearch;
+    parent: IndexWidget | null;
+    uiState: UiState;
+};
+export declare type IndexRenderOptions = {
+    instantSearchInstance: InstantSearch;
+};
 export declare type IndexWidgetDescription = {
     $$type: 'ais.index';
     $$widgetType: 'ais.index';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.40.4",
+  "version": "4.41.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",