instantsearch.js 4.38.0 → 4.39.1

package/es/components/ToggleRefinement/ToggleRefinement.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-environment jsdom
+ */
 /** @jsx h */
 import { h } from 'preact';
 import type { ToggleRefinementRenderState, ToggleRefinementValue } from '../../connectors/toggle-refinement/connectToggleRefinement';

package/es/components/ToggleRefinement/ToggleRefinement.js

@@ -1,5 +1,9 @@
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
+/**
+ * @jest-environment jsdom
+ */
+
 /** @jsx h */
 import { h } from 'preact';
 import Template from "../Template/Template.js";

package/es/connectors/hits/connectHits.d.ts

@@ -1,15 +1,15 @@
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
-import type { TransformItems, Connector, Hits, Hit, WidgetRenderState } from '../../types';
+import type { TransformItems, Connector, Hit, WidgetRenderState, BaseHit } from '../../types';
 import type { SearchResults } from 'algoliasearch-helper';
-export declare type HitsRenderState = {
+export declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -19,7 +19,7 @@ export declare type HitsRenderState = {
      */
     bindEvent: BindEventForHits;
 };
-export declare type HitsConnectorParams = {
+export declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Whether to escape HTML tags from hits string values.
      *
@@ -29,15 +29,15 @@ export declare type HitsConnectorParams = {
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
 };
-export declare type HitsWidgetDescription = {
+export declare type HitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.hits';
-    renderState: HitsRenderState;
+    renderState: HitsRenderState<THit>;
     indexRenderState: {
-        hits: WidgetRenderState<HitsRenderState, HitsConnectorParams>;
+        hits: WidgetRenderState<HitsRenderState<THit>, HitsConnectorParams<THit>>;
     };
 };
-export declare type HitsConnector = Connector<HitsWidgetDescription, HitsConnectorParams>;
+export declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
 declare const connectHits: HitsConnector;
 export default connectHits;

package/es/connectors/hits/connectHits.js

@@ -33,10 +33,10 @@ var connectHits = function connectHits(renderFn) {
       },
       render: function render(renderOptions) {
         var renderState = this.getWidgetRenderState(renderOptions);
-        renderState.sendEvent('view', renderState.hits);
         renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
           instantSearchInstance: renderOptions.instantSearchInstance
         }), false);
+        renderState.sendEvent('view', renderState.hits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

package/es/connectors/hits/connectHitsWithInsights.d.ts

@@ -1,2 +1,2 @@
-declare const connectHitsWithInsights: import("./connectHits").HitsConnector;
+declare const connectHitsWithInsights: import("./connectHits").HitsConnector<import("../../types").BaseHit>;
 export default connectHitsWithInsights;

package/es/connectors/infinite-hits/connectInfiniteHits.d.ts

@@ -1,21 +1,21 @@
 import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
-import type { Hits, Connector, TransformItems, Hit, WidgetRenderState } from '../../types';
+import type { Connector, TransformItems, Hit, WidgetRenderState, BaseHit } from '../../types';
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
-export declare type InfiniteHitsCachedHits = {
-    [page: number]: Hits;
+export declare type InfiniteHitsCachedHits<THit extends BaseHit> = {
+    [page: number]: Array<Hit<THit>>;
 };
-declare type Read = ({ state, }: {
+declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
-}) => InfiniteHitsCachedHits | null;
-declare type Write = ({ state, hits, }: {
+}) => InfiniteHitsCachedHits<THit> | null;
+declare type Write<THit extends BaseHit> = ({ state, hits, }: {
     state: PlainSearchParameters;
-    hits: InfiniteHitsCachedHits;
+    hits: InfiniteHitsCachedHits<THit>;
 }) => void;
-export declare type InfiniteHitsCache = {
-    read: Read;
-    write: Write;
+export declare type InfiniteHitsCache<THit extends BaseHit = BaseHit> = {
+    read: Read<THit>;
+    write: Write<THit>;
 };
-export declare type InfiniteHitsConnectorParams = {
+export declare type InfiniteHitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Escapes HTML entities from hits string values.
      *
@@ -32,15 +32,15 @@ export declare type InfiniteHitsConnectorParams = {
      * Receives the items, and is called before displaying them.
      * Useful for mapping over the items to transform, and remove or reorder them.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
     /**
      * Reads and writes hits from/to cache.
      * When user comes back to the search page after leaving for product page,
      * this helps restore InfiniteHits and its scroll position.
      */
-    cache?: InfiniteHitsCache;
+    cache?: InfiniteHitsCache<THit>;
 };
-export declare type InfiniteHitsRenderState = {
+export declare type InfiniteHitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * Loads the previous results.
      */
@@ -68,26 +68,26 @@ export declare type InfiniteHitsRenderState = {
     /**
      * Hits for the current page
      */
-    currentPageHits: Hits;
+    currentPageHits: Array<Hit<THit>>;
     /**
      * Hits for current and cached pages
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
 };
-export declare type InfiniteHitsWidgetDescription = {
+export declare type InfiniteHitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.infiniteHits';
-    renderState: InfiniteHitsRenderState;
+    renderState: InfiniteHitsRenderState<THit>;
     indexRenderState: {
-        infiniteHits: WidgetRenderState<InfiniteHitsRenderState, InfiniteHitsConnectorParams>;
+        infiniteHits: WidgetRenderState<InfiniteHitsRenderState<THit>, InfiniteHitsConnectorParams<THit>>;
     };
     indexUiState: {
         page: number;
     };
 };
-export declare type InfiniteHitsConnector = Connector<InfiniteHitsWidgetDescription, InfiniteHitsConnectorParams>;
+export declare type InfiniteHitsConnector<THit extends BaseHit = BaseHit> = Connector<InfiniteHitsWidgetDescription<THit>, InfiniteHitsConnectorParams<THit>>;
 declare const connectInfiniteHits: InfiniteHitsConnector;
 export default connectInfiniteHits;

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

@@ -61,7 +61,8 @@ function extractHitsFromCachedHits(cachedHits) {
 
 var connectInfiniteHits = function connectInfiniteHits(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
-  checkRendering(renderFn, withUsage());
+  checkRendering(renderFn, withUsage()); // @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,
@@ -132,10 +133,10 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
       render: function render(renderOptions) {
         var instantSearchInstance = renderOptions.instantSearchInstance;
         var widgetRenderState = this.getWidgetRenderState(renderOptions);
-        sendEvent('view', widgetRenderState.currentPageHits);
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), false);
+        sendEvent('view', widgetRenderState.currentPageHits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

package/es/connectors/infinite-hits/connectInfiniteHitsWithInsights.d.ts

@@ -1,2 +1,2 @@
-declare const connectInfiniteHitsWithInsights: import("./connectInfiniteHits").InfiniteHitsConnector;
+declare const connectInfiniteHitsWithInsights: import("./connectInfiniteHits").InfiniteHitsConnector<import("../../types").BaseHit>;
 export default connectInfiniteHitsWithInsights;

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

@@ -51,6 +51,17 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It needs to avoid pushing state to history in case of back/forward in browser
      */
     private shouldPushState;
+    /**
+     * Indicates whether the history router is disposed or not.
+     */
+    private isDisposed;
+    /**
+     * 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`.
+     */
+    private latestAcknowledgedHistory;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).

package/es/lib/routers/history.js

@@ -48,16 +48,23 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "shouldPushState", true);
 
+    _defineProperty(this, "isDisposed", false);
+
+    _defineProperty(this, "latestAcknowledgedHistory", 0);
+
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
     this._createURL = createURL;
     this.parseURL = parseURL;
     this.getLocation = getLocation;
-    safelyRunOnBrowser(function () {
+    safelyRunOnBrowser(function (_ref2) {
+      var window = _ref2.window;
+
       var title = _this.windowTitle && _this.windowTitle(_this.read());
 
       setWindowTitle(title);
+      _this.latestAcknowledgedHistory = window.history.length;
     });
   }
   /**
@@ -82,8 +89,8 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function write(routeState) {
       var _this2 = this;
 
-      safelyRunOnBrowser(function (_ref2) {
-        var window = _ref2.window;
+      safelyRunOnBrowser(function (_ref3) {
+        var window = _ref3.window;
 
         var url = _this2.createURL(routeState);
 
@@ -94,10 +101,17 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
 
         _this2.writeTimer = setTimeout(function () {
-          setWindowTitle(title);
+          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)
+
+          var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
 
-          if (_this2.shouldPushState) {
+          if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
             window.history.pushState(routeState, title || '', url);
+            _this2.latestAcknowledgedHistory = window.history.length;
           }
 
           _this2.shouldPushState = true;
@@ -133,8 +147,8 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
       };
 
-      safelyRunOnBrowser(function (_ref3) {
-        var window = _ref3.window;
+      safelyRunOnBrowser(function (_ref4) {
+        var window = _ref4.window;
         window.addEventListener('popstate', _this3._onPopState);
       });
     }
@@ -164,8 +178,9 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function dispose() {
       var _this4 = this;
 
-      safelyRunOnBrowser(function (_ref4) {
-        var window = _ref4.window;
+      this.isDisposed = true;
+      safelyRunOnBrowser(function (_ref5) {
+        var window = _ref5.window;
 
         if (_this4._onPopState) {
           window.removeEventListener('popstate', _this4._onPopState);
@@ -184,12 +199,12 @@ var BrowserHistory = /*#__PURE__*/function () {
 }();
 
 export default function historyRouter() {
-  var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      _ref5$createURL = _ref5.createURL,
-      createURL = _ref5$createURL === void 0 ? function (_ref6) {
-    var qsModule = _ref6.qsModule,
-        routeState = _ref6.routeState,
-        location = _ref6.location;
+  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 protocol = location.protocol,
         hostname = location.hostname,
         _location$port = location.port,
@@ -205,11 +220,11 @@ export default function historyRouter() {
     }
 
     return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-  } : _ref5$createURL,
-      _ref5$parseURL = _ref5.parseURL,
-      parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
-    var qsModule = _ref7.qsModule,
-        location = _ref7.location;
+  } : _ref6$createURL,
+      _ref6$parseURL = _ref6.parseURL,
+      parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
+    var qsModule = _ref8.qsModule,
+        location = _ref8.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
@@ -223,21 +238,21 @@ export default function historyRouter() {
     return qsModule.parse(location.search.slice(1), {
       arrayLimit: 99
     });
-  } : _ref5$parseURL,
-      _ref5$writeDelay = _ref5.writeDelay,
-      writeDelay = _ref5$writeDelay === void 0 ? 400 : _ref5$writeDelay,
-      windowTitle = _ref5.windowTitle,
-      _ref5$getLocation = _ref5.getLocation,
-      getLocation = _ref5$getLocation === void 0 ? function () {
-    return safelyRunOnBrowser(function (_ref8) {
-      var window = _ref8.window;
+  } : _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;
       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.');
       }
     });
-  } : _ref5$getLocation;
+  } : _ref6$getLocation;
 
   return new BrowserHistory({
     createURL: createURL,

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

@@ -1,3 +1,6 @@
+/**
+ * @jest-environment jsdom
+ */
 import type { InstantSearch, Hit, Hits } from '../../types';
 declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => void;
 declare type CustomSendEventForHits = (customPayload: any) => void;

package/es/lib/utils/createSendEventForHits.js

@@ -1,5 +1,8 @@
 function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
+/**
+ * @jest-environment jsdom
+ */
 import { serializePayload } from "./serializer.js";
 
 function chunk(arr) {

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.38.0";
+declare const _default: "4.39.1";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.38.0';
+export default '4.39.1';

package/es/middlewares/createMetadataMiddleware.js

@@ -46,8 +46,10 @@ function extractPayload(widgets, instantSearchInstance, payload) {
 
 export function isMetadataEnabled() {
   return safelyRunOnBrowser(function (_ref) {
+    var _window$navigator, _window$navigator$use;
+
     var window = _ref.window;
-    return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+    return ((_window$navigator = window.navigator) === null || _window$navigator === void 0 ? void 0 : (_window$navigator$use = _window$navigator.userAgent) === null || _window$navigator$use === void 0 ? void 0 : _window$navigator$use.indexOf('Algolia Crawler')) > -1;
   }, {
     fallback: function fallback() {
       return false;

package/es/types/results.d.ts

@@ -16,8 +16,7 @@ export declare type GeoLoc = {
     lat: number;
     lng: number;
 };
-export declare type AlgoliaHit = {
-    [attribute: string]: any;
+export declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
     objectID: string;
     _highlightResult?: HitHighlightResult;
     _snippetResult?: HitSnippetResult;
@@ -40,11 +39,15 @@ export declare type AlgoliaHit = {
     };
     _distinctSeqID?: number;
     _geoLoc?: GeoLoc;
-};
-export declare type Hit = {
+} & THit;
+export declare type BaseHit = Record<string, unknown>;
+export declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
     __queryID?: string;
-} & AlgoliaHit;
+} & AlgoliaHit<THit>;
+/**
+ * @deprecated use Hit[] directly instead
+ */
 export declare type Hits = Hit[];
 export declare type EscapedHits<THit = Hit> = THit[] & {
     __escaped: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.38.0",
+  "version": "4.39.1",
   "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",
@@ -39,8 +39,8 @@
     "test": "jest",
     "test:watch": "jest --watch --bail",
     "test:e2e": "yarn test:e2e:local",
-    "test:e2e:local": "wdio wdio.local.conf.js",
-    "test:e2e:saucelabs": "wdio wdio.saucelabs.conf.js",
+    "test:e2e:local": "wdio scripts/wdio/local.conf.js",
+    "test:e2e:saucelabs": "wdio scripts/wdio/saucelabs.conf.js",
     "test:size": "bundlesize",
     "test:argos": "argos upload functional-tests/screenshots --token $ARGOS_TOKEN || true",
     "test:exports": "node test/module/is-es-module.mjs",
@@ -120,7 +120,7 @@
     "eslint-plugin-prettier": "3.4.0",
     "eslint-plugin-react": "7.18.0",
     "eslint-plugin-react-hooks": "2.3.0",
-    "instantsearch-e2e-tests": "algolia/instantsearch-e2e-tests#1.3.0",
+    "instantsearch-e2e-tests": "algolia/instantsearch-e2e-tests#2.0.2",
     "jest": "27.1.0",
     "jest-diff": "27.1.0",
     "jest-environment-jsdom": "27.1.0",