instantsearch.js 4.38.0 → 4.39.1

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [4.39.1](https://github.com/algolia/instantsearch.js/compare/v4.39.0...v4.39.1) (2022-03-01)
+
+
+### Bug Fixes
+
+* **insights:** send view events after rendering ([#5014](https://github.com/algolia/instantsearch.js/issues/5014)) ([e952abc](https://github.com/algolia/instantsearch.js/commit/e952abc64043a55e06c9c46a656bc98ad45d1502))
+
+
+
+# [4.39.0](https://github.com/algolia/instantsearch.js/compare/v4.38.1...v4.39.0) (2022-02-23)
+
+
+### Features
+
+* **ts:** allow Hits related connectors to be generic ([#5019](https://github.com/algolia/instantsearch.js/issues/5019)) ([e986f7e](https://github.com/algolia/instantsearch.js/commit/e986f7e46d57173da4d3d6c3c23fbdf3f9c0f78c))
+
+
+
+## [4.38.1](https://github.com/algolia/instantsearch.js/compare/v4.38.0...v4.38.1) (2022-02-08)
+
+
+### Bug Fixes
+
+* **routing:** fix history router based on history length ([#5004](https://github.com/algolia/instantsearch.js/issues/5004)) ([40541af](https://github.com/algolia/instantsearch.js/commit/40541af5c8face0e32a1ec3a4665a8387d89c626))
+* **metadata:** ensure safe user agent detection ([#5009](https://github.com/algolia/instantsearch.js/pull/5009) [15a6a9d](https://github.com/algolia/instantsearch.js/commit/15a6a9d10ee512fab6884696bc59bedea13bd1b3))
+
+
 # [4.38.0](https://github.com/algolia/instantsearch.js/compare/v4.37.3...v4.38.0) (2022-01-28)
 
 

package/cjs/connectors/hits/connectHits.js

@@ -41,10 +41,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/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -69,7 +69,8 @@ function extractHitsFromCachedHits(cachedHits) {
 
 var connectInfiniteHits = function connectInfiniteHits(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _index.noop;
-  (0, _index.checkRendering)(renderFn, withUsage());
+  (0, _index.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,
@@ -140,10 +141,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/cjs/lib/routers/history.js

@@ -58,16 +58,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;
-    (0, _index.safelyRunOnBrowser)(function () {
+    (0, _index.safelyRunOnBrowser)(function (_ref2) {
+      var window = _ref2.window;
+
       var title = _this.windowTitle && _this.windowTitle(_this.read());
 
       setWindowTitle(title);
+      _this.latestAcknowledgedHistory = window.history.length;
     });
   }
   /**
@@ -92,8 +99,8 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function write(routeState) {
       var _this2 = this;
 
-      (0, _index.safelyRunOnBrowser)(function (_ref2) {
-        var window = _ref2.window;
+      (0, _index.safelyRunOnBrowser)(function (_ref3) {
+        var window = _ref3.window;
 
         var url = _this2.createURL(routeState);
 
@@ -104,10 +111,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;
@@ -143,8 +157,8 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
       };
 
-      (0, _index.safelyRunOnBrowser)(function (_ref3) {
-        var window = _ref3.window;
+      (0, _index.safelyRunOnBrowser)(function (_ref4) {
+        var window = _ref4.window;
         window.addEventListener('popstate', _this3._onPopState);
       });
     }
@@ -174,8 +188,9 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function dispose() {
       var _this4 = this;
 
-      (0, _index.safelyRunOnBrowser)(function (_ref4) {
-        var window = _ref4.window;
+      this.isDisposed = true;
+      (0, _index.safelyRunOnBrowser)(function (_ref5) {
+        var window = _ref5.window;
 
         if (_this4._onPopState) {
           window.removeEventListener('popstate', _this4._onPopState);
@@ -194,12 +209,12 @@ var BrowserHistory = /*#__PURE__*/function () {
 }();
 
 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,
@@ -215,11 +230,11 @@ 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
@@ -233,21 +248,21 @@ 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 (0, _index.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 (0, _index.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/cjs/lib/version.js

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

package/cjs/middlewares/createMetadataMiddleware.js

@@ -54,8 +54,10 @@ function extractPayload(widgets, instantSearchInstance, payload) {
 
 function isMetadataEnabled() {
   return (0, _index.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/dist/instantsearch.development.d.ts

@@ -12,8 +12,7 @@ import { default as qs_2 } from 'qs';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
-declare type AlgoliaHit = {
-    [attribute: string]: any;
+declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
     objectID: string;
     _highlightResult?: HitHighlightResult;
     _snippetResult?: HitSnippetResult;
@@ -36,7 +35,7 @@ declare type AlgoliaHit = {
     };
     _distinctSeqID?: number;
     _geoLoc?: GeoLoc;
-};
+} & THit;
 
 declare const analytics: AnalyticsWidget;
 
@@ -292,6 +291,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type BaseHit = Record<string, unknown>;
+
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
 
 declare type Bounds = {
@@ -466,6 +467,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).
@@ -723,11 +735,11 @@ declare const connectHits: HitsConnector;
 
 declare const connectHitsPerPage: HitsPerPageConnector;
 
-declare const connectHitsWithInsights: HitsConnector;
+declare const connectHitsWithInsights: HitsConnector<BaseHit>;
 
 declare const connectInfiniteHits: InfiniteHitsConnector;
 
-declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector;
+declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector<BaseHit>;
 
 /**
  * **Menu** connector provides the logic to build a widget that will give the user the ability to choose a single value for a specific facet. The typical usage of menu is for navigation in categories.
@@ -1749,10 +1761,10 @@ declare type HighlightOptions = {
 
 declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
-declare type Hit = {
+declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
     __queryID?: string;
-} & AlgoliaHit;
+} & AlgoliaHit<THit>;
 
 declare type HitAttributeHighlightResult = {
     value: string;
@@ -1767,13 +1779,16 @@ declare type HitHighlightResult = {
     [attribute: string]: HitAttributeHighlightResult | HitAttributeHighlightResult[] | HitHighlightResult[] | HitHighlightResult;
 };
 
+/**
+ * @deprecated use Hit[] directly instead
+ */
 declare type Hits = Hit[];
 
 declare const hits: HitsWidget;
 
-declare type HitsConnector = Connector<HitsWidgetDescription, HitsConnectorParams>;
+declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
 
-declare type HitsConnectorParams = {
+declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Whether to escape HTML tags from hits string values.
      *
@@ -1783,7 +1798,7 @@ declare type HitsConnectorParams = {
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
 };
 
 declare type HitsCSSClasses = Partial<{
@@ -1912,15 +1927,15 @@ declare type HitsPerPageWidgetParams = {
     cssClasses?: HitsPerPageCSSClasses;
 };
 
-declare type HitsRenderState = {
+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.
      */
@@ -1952,11 +1967,11 @@ declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
     $$widgetType: 'ais.hits';
 }, HitsConnectorParams, HitsWidgetParams>;
 
-declare type HitsWidgetDescription = {
+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>>;
     };
 };
 
@@ -2037,18 +2052,18 @@ declare type IndexWidgetParams = {
 
 declare const infiniteHits: InfiniteHitsWidget;
 
-declare type InfiniteHitsCache = {
-    read: Read;
-    write: Write;
+declare type InfiniteHitsCache<THit extends BaseHit = BaseHit> = {
+    read: Read<THit>;
+    write: Write<THit>;
 };
 
-declare type InfiniteHitsCachedHits = {
-    [page: number]: Hits;
+declare type InfiniteHitsCachedHits<THit extends BaseHit> = {
+    [page: number]: Array<Hit<THit>>;
 };
 
-declare type InfiniteHitsConnector = Connector<InfiniteHitsWidgetDescription, InfiniteHitsConnectorParams>;
+declare type InfiniteHitsConnector<THit extends BaseHit = BaseHit> = Connector<InfiniteHitsWidgetDescription<THit>, InfiniteHitsConnectorParams<THit>>;
 
-declare type InfiniteHitsConnectorParams = {
+declare type InfiniteHitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Escapes HTML entities from hits string values.
      *
@@ -2065,13 +2080,13 @@ 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>;
 };
 
 declare type InfiniteHitsCSSClasses = Partial<{
@@ -2109,7 +2124,7 @@ declare type InfiniteHitsCSSClasses = Partial<{
     disabledLoadMore: string | string[];
 }>;
 
-declare type InfiniteHitsRenderState = {
+declare type InfiniteHitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * Loads the previous results.
      */
@@ -2137,15 +2152,15 @@ 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>>;
 };
 
 declare type InfiniteHitsTemplates = Partial<{
@@ -2175,11 +2190,11 @@ declare type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription &
     $$widgetType: 'ais.infiniteHits';
 }, InfiniteHitsConnectorParams, InfiniteHitsWidgetParams>;
 
-declare type InfiniteHitsWidgetDescription = {
+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;
@@ -3796,9 +3811,9 @@ declare type RatingMenuWidgetParams = {
     cssClasses?: RatingMenuCSSClasses;
 };
 
-declare type Read = ({ state, }: {
+declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
-}) => InfiniteHitsCachedHits | null;
+}) => InfiniteHitsCachedHits<THit> | null;
 
 declare type ReconfigurableOptions = Places.ReconfigurableOptions;
 
@@ -5240,9 +5255,9 @@ declare type WidgetType<TWidgetDescription extends WidgetDescription> = TWidgetD
 
 declare type WidgetUiStates = PlacesWidgetDescription['indexUiState'];
 
-declare type Write = ({ state, hits, }: {
+declare type Write<THit extends BaseHit> = ({ state, hits, }: {
     state: PlainSearchParameters;
-    hits: InfiniteHitsCachedHits;
+    hits: InfiniteHitsCachedHits<THit>;
 }) => void;
 
 export { }