react-instantsearch 6.40.4 → 7.0.1

package/dist/es/widgets/SearchBox.js

@@ -0,0 +1,83 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+var _excluded = ["queryHook", "searchAsYouType", "translations"];
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+import React, { useRef, useState } from 'react';
+import { useSearchBox } from 'react-instantsearch-core';
+import { SearchBox as SearchBoxUiComponent } from "../ui/SearchBox.js";
+export function SearchBox(_ref) {
+  var queryHook = _ref.queryHook,
+    _ref$searchAsYouType = _ref.searchAsYouType,
+    searchAsYouType = _ref$searchAsYouType === void 0 ? true : _ref$searchAsYouType,
+    translations = _ref.translations,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _useSearchBox = useSearchBox({
+      queryHook: queryHook
+    }, {
+      $$widgetType: 'ais.searchBox'
+    }),
+    query = _useSearchBox.query,
+    refine = _useSearchBox.refine,
+    isSearchStalled = _useSearchBox.isSearchStalled;
+  var _useState = useState(query),
+    _useState2 = _slicedToArray(_useState, 2),
+    inputValue = _useState2[0],
+    setInputValue = _useState2[1];
+  var inputRef = useRef(null);
+  function setQuery(newQuery) {
+    setInputValue(newQuery);
+    if (searchAsYouType) {
+      refine(newQuery);
+    }
+  }
+  function onReset() {
+    setQuery('');
+    if (!searchAsYouType) {
+      refine('');
+    }
+  }
+  function onChange(event) {
+    setQuery(event.currentTarget.value);
+  }
+  function onSubmit(event) {
+    if (!searchAsYouType) {
+      refine(inputValue);
+    }
+    if (props.onSubmit) {
+      props.onSubmit(event);
+    }
+  }
+
+  // Track when the InstantSearch query changes to synchronize it with
+  // the React state.
+  // We bypass the state update if the input is focused to avoid concurrent
+  // updates when typing.
+  if (query !== inputValue && document.activeElement !== inputRef.current) {
+    setInputValue(query);
+  }
+  var uiProps = {
+    inputRef: inputRef,
+    isSearchStalled: isSearchStalled,
+    onChange: onChange,
+    onReset: onReset,
+    onSubmit: onSubmit,
+    value: inputValue,
+    translations: _objectSpread({
+      submitButtonTitle: 'Submit the search query',
+      resetButtonTitle: 'Clear the search query'
+    }, translations)
+  };
+  return /*#__PURE__*/React.createElement(SearchBoxUiComponent, _extends({}, props, uiProps));
+}

package/dist/es/widgets/Snippet.d.ts

@@ -0,0 +1,8 @@
+import type { PartialKeys } from '../types';
+import type { SnippetProps as SnippetUiComponentProps } from '../ui/Snippet';
+import type { BaseHit, Hit } from 'instantsearch.js';
+export type SnippetProps<THit extends Hit<BaseHit>> = {
+    hit: THit;
+    attribute: keyof THit | string[];
+} & PartialKeys<Omit<SnippetUiComponentProps, 'parts'>, 'highlightedTagName' | 'nonHighlightedTagName' | 'separator'>;
+export declare function Snippet<THit extends Hit<BaseHit>>({ hit, attribute, highlightedTagName, nonHighlightedTagName, separator, ...props }: SnippetProps<THit>): JSX.Element;

package/dist/es/widgets/Snippet.js

@@ -0,0 +1,26 @@
+var _excluded = ["hit", "attribute", "highlightedTagName", "nonHighlightedTagName", "separator"];
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+import { getHighlightedParts, getPropertyByPath, unescape } from "instantsearch.js/es/lib/utils/index.js";
+import React from 'react';
+import { Snippet as SnippetUiComponent } from "../ui/Snippet.js";
+export function Snippet(_ref) {
+  var hit = _ref.hit,
+    attribute = _ref.attribute,
+    highlightedTagName = _ref.highlightedTagName,
+    nonHighlightedTagName = _ref.nonHighlightedTagName,
+    separator = _ref.separator,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var property = getPropertyByPath(hit._snippetResult, attribute) || [];
+  var properties = Array.isArray(property) ? property : [property];
+  var parts = properties.map(function (singleValue) {
+    return getHighlightedParts(unescape(singleValue.value || ''));
+  });
+  return /*#__PURE__*/React.createElement(SnippetUiComponent, _extends({}, props, {
+    parts: parts,
+    highlightedTagName: highlightedTagName,
+    nonHighlightedTagName: nonHighlightedTagName,
+    separator: separator
+  }));
+}

package/dist/es/widgets/SortBy.d.ts

@@ -0,0 +1,6 @@
+import type { SortByProps as SortByUiComponentProps } from '../ui/SortBy';
+import type { UseSortByProps } from 'react-instantsearch-core';
+type UiProps = Pick<SortByUiComponentProps, 'items' | 'value' | 'onChange'>;
+export type SortByProps = Omit<SortByUiComponentProps, keyof UiProps> & UseSortByProps;
+export declare function SortBy({ items, transformItems, ...props }: SortByProps): JSX.Element;
+export {};

package/dist/es/widgets/SortBy.js

@@ -0,0 +1,27 @@
+var _excluded = ["items", "transformItems"];
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+import React from 'react';
+import { useSortBy } from 'react-instantsearch-core';
+import { SortBy as SortByUiComponent } from "../ui/SortBy.js";
+export function SortBy(_ref) {
+  var items = _ref.items,
+    transformItems = _ref.transformItems,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _useSortBy = useSortBy({
+      items: items,
+      transformItems: transformItems
+    }, {
+      $$widgetType: 'ais.sortBy'
+    }),
+    currentRefinement = _useSortBy.currentRefinement,
+    options = _useSortBy.options,
+    refine = _useSortBy.refine;
+  var uiProps = {
+    items: options,
+    value: currentRefinement,
+    onChange: refine
+  };
+  return /*#__PURE__*/React.createElement(SortByUiComponent, _extends({}, props, uiProps));
+}

package/dist/es/widgets/Stats.d.ts

@@ -0,0 +1,8 @@
+import type { StatsProps as StatsUiComponentProps } from '../ui/Stats';
+import type { UseStatsProps } from 'react-instantsearch-core';
+type UiProps = Pick<StatsUiComponentProps, 'nbHits' | 'nbSortedHits' | 'processingTimeMS' | 'areHitsSorted' | 'translations'>;
+export type StatsProps = Omit<StatsUiComponentProps, keyof UiProps> & UseStatsProps & {
+    translations?: Partial<UiProps['translations']>;
+};
+export declare function Stats({ translations, ...props }: StatsProps): JSX.Element;
+export {};

package/dist/es/widgets/Stats.js

@@ -0,0 +1,36 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+var _excluded = ["translations"];
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+import React from 'react';
+import { useStats } from 'react-instantsearch-core';
+import { Stats as StatsUiComponent } from "../ui/Stats.js";
+export function Stats(_ref) {
+  var translations = _ref.translations,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _useStats = useStats(undefined, {
+      $$widgetType: 'ais.stats'
+    }),
+    nbHits = _useStats.nbHits,
+    nbSortedHits = _useStats.nbSortedHits,
+    processingTimeMS = _useStats.processingTimeMS,
+    areHitsSorted = _useStats.areHitsSorted;
+  var uiProps = {
+    nbHits: nbHits,
+    nbSortedHits: nbSortedHits,
+    processingTimeMS: processingTimeMS,
+    areHitsSorted: areHitsSorted,
+    translations: _objectSpread({
+      rootElementText: function rootElementText(options) {
+        return options.areHitsSorted ? "".concat(options.nbSortedHits.toLocaleString(), " relevant results sorted out of ").concat(options.nbHits.toLocaleString(), " found in ").concat(options.processingTimeMS.toLocaleString(), "ms") : "".concat(options.nbHits.toLocaleString(), " results found in ").concat(options.processingTimeMS.toLocaleString(), "ms");
+      }
+    }, translations)
+  };
+  return /*#__PURE__*/React.createElement(StatsUiComponent, _extends({}, props, uiProps));
+}

package/dist/es/widgets/ToggleRefinement.d.ts

@@ -0,0 +1,7 @@
+import type { PartialKeys } from '../types';
+import type { ToggleRefinementProps as ToggleRefinementUiComponentProps } from '../ui/ToggleRefinement';
+import type { UseToggleRefinementProps } from 'react-instantsearch-core';
+type UiProps = Pick<ToggleRefinementUiComponentProps, 'onChange' | 'checked'>;
+export type ToggleRefinementProps = PartialKeys<Omit<ToggleRefinementUiComponentProps, keyof UiProps>, 'label'> & UseToggleRefinementProps;
+export declare function ToggleRefinement({ attribute, on, off, ...props }: ToggleRefinementProps): JSX.Element;
+export {};

package/dist/es/widgets/ToggleRefinement.js

@@ -0,0 +1,33 @@
+var _excluded = ["attribute", "on", "off"];
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+import React from 'react';
+import { useToggleRefinement } from 'react-instantsearch-core';
+import { ToggleRefinement as ToggleRefinementUiComponent } from "../ui/ToggleRefinement.js";
+export function ToggleRefinement(_ref) {
+  var attribute = _ref.attribute,
+    on = _ref.on,
+    off = _ref.off,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _useToggleRefinement = useToggleRefinement({
+      attribute: attribute,
+      on: on,
+      off: off
+    }, {
+      $$widgetType: 'ais.toggleRefinement'
+    }),
+    refine = _useToggleRefinement.refine,
+    value = _useToggleRefinement.value;
+  var uiProps = {
+    checked: value.isRefined,
+    onChange: function onChange(isChecked) {
+      return refine({
+        isRefined: !isChecked
+      });
+    }
+  };
+  return /*#__PURE__*/React.createElement(ToggleRefinementUiComponent, _extends({
+    label: value.name
+  }, props, uiProps));
+}

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

@@ -0,0 +1,18 @@
+export * from './Breadcrumb';
+export * from './ClearRefinements';
+export * from './CurrentRefinements';
+export * from './HierarchicalMenu';
+export * from './Highlight';
+export * from './Hits';
+export * from './HitsPerPage';
+export * from './InfiniteHits';
+export * from './Menu';
+export * from './Pagination';
+export * from './PoweredBy';
+export * from './RangeInput';
+export * from './RefinementList';
+export * from './SearchBox';
+export * from './Snippet';
+export * from './SortBy';
+export * from './Stats';
+export * from './ToggleRefinement';

package/dist/es/widgets/index.js

@@ -0,0 +1,18 @@
+export * from "./Breadcrumb.js";
+export * from "./ClearRefinements.js";
+export * from "./CurrentRefinements.js";
+export * from "./HierarchicalMenu.js";
+export * from "./Highlight.js";
+export * from "./Hits.js";
+export * from "./HitsPerPage.js";
+export * from "./InfiniteHits.js";
+export * from "./Menu.js";
+export * from "./Pagination.js";
+export * from "./PoweredBy.js";
+export * from "./RangeInput.js";
+export * from "./RefinementList.js";
+export * from "./SearchBox.js";
+export * from "./Snippet.js";
+export * from "./SortBy.js";
+export * from "./Stats.js";
+export * from "./ToggleRefinement.js";