instantsearch.js 4.37.1 → 4.38.1

package/es/helpers/reverseSnippet.js

@@ -1,4 +1,4 @@
-import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts } from "../lib/utils/index.js";
+import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 import { component } from "../lib/suit.js";
 var suit = component('ReverseSnippet');
 export default function reverseSnippet(_ref) {
@@ -8,8 +8,11 @@ export default function reverseSnippet(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-  var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? warning(snippetAttributeResult, "Could not enable reverse snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = snippetAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/es/helpers/snippet.js

@@ -1,5 +1,5 @@
 import { component } from "../lib/suit.js";
-import { TAG_REPLACEMENT, getPropertyByPath } from "../lib/utils/index.js";
+import { TAG_REPLACEMENT, getPropertyByPath, warning } from "../lib/utils/index.js";
 var suit = component('Snippet');
 export default function snippet(_ref) {
   var attribute = _ref.attribute,
@@ -8,8 +8,11 @@ export default function snippet(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-  var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? warning(snippetAttributeResult, "Could not enable snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = snippetAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

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/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.37.1";
+declare const _default: "4.38.1";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.37.1';
+export default '4.38.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/widget.d.ts

@@ -129,10 +129,13 @@ declare type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription &
 export declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
+export declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 /**
  * Transforms the given items.
  */
-export declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+export declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
 /**
  * Transforms the given items.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.37.1",
+  "version": "4.38.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",
@@ -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",
@@ -140,7 +140,7 @@
     "rollup-plugin-uglify": "6.0.4",
     "scriptjs": "2.5.9",
     "semver": "6.3.0",
-    "shelljs": "0.8.3",
+    "shelljs": "0.8.4",
     "shipjs": "0.21.0",
     "typescript": "4.3.5",
     "webpack": "4.41.5"

package/cjs/components/Pagination/PaginationLink.js

@@ -1,60 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _preact = require("preact");
-
-var _classnames = _interopRequireDefault(require("classnames"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/** @jsx h */
-function PaginationLink(_ref) {
-  var label = _ref.label,
-      ariaLabel = _ref.ariaLabel,
-      pageNumber = _ref.pageNumber,
-      _ref$additionalClassN = _ref.additionalClassName,
-      additionalClassName = _ref$additionalClassN === void 0 ? null : _ref$additionalClassN,
-      _ref$isDisabled = _ref.isDisabled,
-      isDisabled = _ref$isDisabled === void 0 ? false : _ref$isDisabled,
-      _ref$isSelected = _ref.isSelected,
-      isSelected = _ref$isSelected === void 0 ? false : _ref$isSelected,
-      cssClasses = _ref.cssClasses,
-      createURL = _ref.createURL,
-      handleClick = _ref.handleClick;
-  var classes = {
-    item: (0, _classnames.default)(cssClasses.item, additionalClassName, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem),
-    link: cssClasses.link
-  };
-
-  if (isDisabled) {
-    return (0, _preact.h)("li", {
-      className: classes.item
-    }, (0, _preact.h)("span", {
-      className: classes.link,
-      dangerouslySetInnerHTML: {
-        __html: label
-      }
-    }));
-  }
-
-  return (0, _preact.h)("li", {
-    className: classes.item
-  }, (0, _preact.h)("a", {
-    className: classes.link,
-    "aria-label": ariaLabel,
-    href: createURL(pageNumber),
-    onClick: function onClick(event) {
-      return handleClick(pageNumber, event);
-    },
-    dangerouslySetInnerHTML: {
-      __html: label
-    }
-  }));
-}
-
-var _default = PaginationLink;
-exports.default = _default;