instantsearch.js 4.37.1 → 4.37.2

package/es/components/Hits/Hits.d.ts

@@ -15,13 +15,5 @@ export declare type HitsProps = {
     cssClasses: HitsComponentCSSClasses;
     templateProps: PreparedTemplateProps<HitsComponentTemplates>;
 };
-declare const Hits: {
-    ({ results, hits, bindEvent, cssClasses, templateProps, }: HitsProps): h.JSX.Element;
-    defaultProps: {
-        results: {
-            hits: never[];
-        };
-        hits: never[];
-    };
-};
+declare const Hits: ({ results, hits, bindEvent, cssClasses, templateProps, }: HitsProps) => h.JSX.Element;
 export default Hits;

package/es/components/Hits/Hits.js

@@ -48,10 +48,4 @@ var Hits = function Hits(_ref) {
   })));
 };
 
-Hits.defaultProps = {
-  results: {
-    hits: []
-  },
-  hits: []
-};
 export default Hits;

package/es/components/Pagination/Pagination.d.ts

@@ -7,10 +7,10 @@ export declare type PaginationComponentTemplates = Required<PaginationTemplates>
 export declare type PaginationProps = {
     createURL(value: number): string;
     cssClasses: PaginationComponentCSSClasses;
-    currentPage: number;
     templates: PaginationComponentTemplates;
-    nbPages?: number;
-    pages?: number[];
+    currentPage: number;
+    nbPages: number;
+    pages: number[];
     isFirstPage: boolean;
     isLastPage: boolean;
     setCurrentPage(value: number): void;
@@ -20,11 +20,4 @@ export declare type PaginationProps = {
     showNext?: boolean;
 };
 declare function Pagination(props: PaginationProps): h.JSX.Element;
-declare namespace Pagination {
-    var defaultProps: {
-        currentPage: number;
-        nbPages: number;
-        pages: never[];
-    };
-}
 export default Pagination;

package/es/components/Pagination/Pagination.js

@@ -3,84 +3,105 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 /** @jsx h */
 import { h } from 'preact';
 import cx from 'classnames';
-import PaginationLink from "./PaginationLink.js";
 import { isSpecialClick } from "../../lib/utils/index.js";
-var defaultProps = {
-  currentPage: 0,
-  nbPages: 0,
-  pages: []
-};
 
 function Pagination(props) {
-  var handleClick = function handleClick(pageNumber, event) {
-    if (isSpecialClick(event)) {
-      // do not alter the default browser behavior
-      // if one special key is down
-      return;
-    }
+  function createClickHandler(pageNumber) {
+    return function (event) {
+      if (isSpecialClick(event)) {
+        // do not alter the default browser behavior
+        // if one special key is down
+        return;
+      }
 
-    event.preventDefault();
-    props.setCurrentPage(pageNumber);
-  };
+      event.preventDefault();
+      props.setCurrentPage(pageNumber);
+    };
+  }
 
   return h("div", {
     className: cx(props.cssClasses.root, _defineProperty({}, props.cssClasses.noRefinementRoot, props.nbPages <= 1))
   }, h("ul", {
     className: props.cssClasses.list
   }, props.showFirst && h(PaginationLink, {
-    key: "first",
-    ariaLabel: 'First',
-    additionalClassName: props.cssClasses.firstPageItem,
+    ariaLabel: "First",
+    className: props.cssClasses.firstPageItem,
     isDisabled: props.isFirstPage,
     label: props.templates.first,
     pageNumber: 0,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
-    handleClick: handleClick
+    createClickHandler: createClickHandler
   }), props.showPrevious && h(PaginationLink, {
-    key: "previous",
-    ariaLabel: 'Previous',
-    additionalClassName: props.cssClasses.previousPageItem,
+    ariaLabel: "Previous",
+    className: props.cssClasses.previousPageItem,
     isDisabled: props.isFirstPage,
     label: props.templates.previous,
     pageNumber: props.currentPage - 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
-    handleClick: handleClick
+    createClickHandler: createClickHandler
   }), props.pages.map(function (pageNumber) {
     return h(PaginationLink, {
       key: pageNumber,
       ariaLabel: "".concat(pageNumber + 1),
-      additionalClassName: props.cssClasses.pageItem,
+      className: props.cssClasses.pageItem,
       isSelected: pageNumber === props.currentPage,
       label: "".concat(pageNumber + 1),
       pageNumber: pageNumber,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
-      handleClick: handleClick
+      createClickHandler: createClickHandler
     });
   }), props.showNext && h(PaginationLink, {
-    key: "next",
-    ariaLabel: 'Next',
-    additionalClassName: props.cssClasses.nextPageItem,
+    ariaLabel: "Next",
+    className: props.cssClasses.nextPageItem,
     isDisabled: props.isLastPage,
     label: props.templates.next,
     pageNumber: props.currentPage + 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
-    handleClick: handleClick
+    createClickHandler: createClickHandler
   }), props.showLast && h(PaginationLink, {
-    key: "last",
-    ariaLabel: 'Last',
-    additionalClassName: props.cssClasses.lastPageItem,
+    ariaLabel: "Last",
+    className: props.cssClasses.lastPageItem,
     isDisabled: props.isLastPage,
     label: props.templates.last,
     pageNumber: props.nbPages - 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
-    handleClick: handleClick
+    createClickHandler: createClickHandler
   })));
 }
 
-Pagination.defaultProps = defaultProps;
+function PaginationLink(_ref) {
+  var label = _ref.label,
+      ariaLabel = _ref.ariaLabel,
+      pageNumber = _ref.pageNumber,
+      className = _ref.className,
+      _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,
+      createClickHandler = _ref.createClickHandler;
+  return h("li", {
+    className: cx(cssClasses.item, className, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem)
+  }, isDisabled ? h("span", {
+    className: cssClasses.link,
+    dangerouslySetInnerHTML: {
+      __html: label
+    }
+  }) : h("a", {
+    className: cssClasses.link,
+    "aria-label": ariaLabel,
+    href: createURL(pageNumber),
+    onClick: createClickHandler(pageNumber),
+    dangerouslySetInnerHTML: {
+      __html: label
+    }
+  }));
+}
+
 export default Pagination;

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

@@ -10,32 +10,28 @@ var withUsage = createDocumentationMessageGenerator({
   connector: true
 });
 
+var defaultQueryHook = function defaultQueryHook(query, hook) {
+  return hook(query);
+};
 /**
  * **SearchBox** connector provides the logic to build a widget that will let the user search for a query.
  *
  * The connector provides to the rendering: `refine()` to set the query. The behaviour of this function
  * may be impacted by the `queryHook` widget parameter.
  */
+
+
 var connectSearchBox = function connectSearchBox(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
   checkRendering(renderFn, withUsage());
   return function (widgetParams) {
     var _ref = widgetParams || {},
-        queryHook = _ref.queryHook;
-
-    function clear(helper) {
-      return function () {
-        helper.setQuery('').search();
-      };
-    }
+        _ref$queryHook = _ref.queryHook,
+        queryHook = _ref$queryHook === void 0 ? defaultQueryHook : _ref$queryHook;
 
     var _refine;
 
-    var _clear = function _clear() {};
-
-    function _cachedClear() {
-      _clear();
-    }
+    var _clear;
 
     return {
       $$type: 'ais.searchBox',
@@ -67,27 +63,21 @@ var connectSearchBox = function connectSearchBox(renderFn) {
             state = _ref3.state;
 
         if (!_refine) {
-          var setQueryAndSearch = function setQueryAndSearch(query) {
-            if (query !== state.query) {
-              helper.setQuery(query).search();
-            }
-          };
-
           _refine = function _refine(query) {
-            if (queryHook) {
-              queryHook(query, setQueryAndSearch);
-              return;
-            }
+            queryHook(query, function (q) {
+              return helper.setQuery(q).search();
+            });
+          };
 
-            setQueryAndSearch(query);
+          _clear = function _clear() {
+            helper.setQuery('').search();
           };
         }
 
-        _clear = clear(helper);
         return {
           query: state.query || '',
           refine: _refine,
-          clear: _cachedClear,
+          clear: _clear,
           widgetParams: widgetParams,
           isSearchStalled: searchMetadata.isSearchStalled
         };

package/es/connectors/toggle-refinement/connectToggleRefinement.d.ts

@@ -3,13 +3,19 @@ declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean,
 declare type CustomSendEventForToggle = (customPayload: any) => void;
 export declare type SendEventForToggle = BuiltInSendEventForToggle & CustomSendEventForToggle;
 export declare type ToggleRefinementValue = {
-    /** whether this option is enabled */
+    /**
+     * Whether this option is enabled.
+     */
     isRefined: boolean;
-    /** number of result if this option is enabled */
+    /**
+     * Number of result if this option is toggled.
+     */
     count: number | null;
 };
 export declare type ToggleRefinementConnectorParams = {
-    /** Name of the attribute for faceting (eg. "free_shipping"). */
+    /**
+     * Name of the attribute for faceting (e.g., "free_shipping").
+     */
     attribute: string;
     /**
      * Value to filter on when toggled.
@@ -24,19 +30,42 @@ export declare type ToggleRefinementConnectorParams = {
 export declare type ToggleRefinementRenderState = {
     /** The current toggle value */
     value: {
+        /**
+         * The attribute name of this toggle.
+         */
         name: string;
+        /**
+         * Whether the current option is "on" (true) or "off" (false)
+         */
         isRefined: boolean;
+        /**
+         * Number of results if this option is toggled.
+         */
         count: number | null;
+        /**
+         * Information about the "on" toggle.
+         */
         onFacetValue: ToggleRefinementValue;
+        /**
+         * Information about the "off" toggle.
+         */
         offFacetValue: ToggleRefinementValue;
     };
-    /** Creates an URL for the next state. */
+    /**
+     * Creates an URL for the next state.
+     */
     createURL: CreateURL<string>;
-    /** send a "facet clicked" insights event */
+    /**
+     * Send a "Facet Clicked" Insights event.
+     */
     sendEvent: SendEventForToggle;
-    /** Indicates if search state can be refined. */
+    /**
+     * Indicates if search state can be refined.
+     */
     canRefine: boolean;
-    /** Updates to the next state by applying the toggle refinement. */
+    /**
+     * Updates to the next state by applying the toggle refinement.
+     */
     refine: (value?: {
         isRefined: boolean;
     }) => void;

package/es/lib/version.d.ts

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

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.37.1';
+export default '4.37.2';

package/package.json

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

package/es/components/Pagination/PaginationLink.d.ts

@@ -1,16 +0,0 @@
-/** @jsx h */
-import { h } from 'preact';
-import type { PaginationComponentCSSClasses } from './Pagination';
-declare type PageLinkProps = {
-    label: string;
-    ariaLabel: string;
-    pageNumber: number;
-    additionalClassName: string | null;
-    isDisabled?: boolean;
-    isSelected?: boolean;
-    cssClasses: PaginationComponentCSSClasses;
-    createURL(value: number): string;
-    handleClick(pageNumber: number, event: MouseEvent): void;
-};
-declare function PaginationLink({ label, ariaLabel, pageNumber, additionalClassName, isDisabled, isSelected, cssClasses, createURL, handleClick, }: PageLinkProps): h.JSX.Element;
-export default PaginationLink;

package/es/components/Pagination/PaginationLink.js

@@ -1,49 +0,0 @@
-/** @jsx h */
-import { h } from 'preact';
-import cx from 'classnames';
-
-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: cx(cssClasses.item, additionalClassName, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem),
-    link: cssClasses.link
-  };
-
-  if (isDisabled) {
-    return h("li", {
-      className: classes.item
-    }, h("span", {
-      className: classes.link,
-      dangerouslySetInnerHTML: {
-        __html: label
-      }
-    }));
-  }
-
-  return h("li", {
-    className: classes.item
-  }, h("a", {
-    className: classes.link,
-    "aria-label": ariaLabel,
-    href: createURL(pageNumber),
-    onClick: function onClick(event) {
-      return handleClick(pageNumber, event);
-    },
-    dangerouslySetInnerHTML: {
-      __html: label
-    }
-  }));
-}
-
-export default PaginationLink;