react-instantsearch-core 6.40.3 → 7.0.0

package/dist/es/connectors/useHits.d.ts

@@ -0,0 +1,5 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { BaseHit } from 'instantsearch.js';
+import type { HitsConnectorParams } from 'instantsearch.js/es/connectors/hits/connectHits';
+export type UseHitsProps<THit extends BaseHit = BaseHit> = HitsConnectorParams<THit>;
+export declare function useHits<THit extends BaseHit = BaseHit>(props?: UseHitsProps<THit>, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/hits/connectHits").HitsRenderState<THit>;

package/dist/es/connectors/useHits.js

@@ -0,0 +1,5 @@
+import connectHits from "instantsearch.js/es/connectors/hits/connectHits.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useHits(props, additionalWidgetProperties) {
+  return useConnector(connectHits, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useHitsPerPage.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { HitsPerPageConnectorParams } from 'instantsearch.js/es/connectors/hits-per-page/connectHitsPerPage';
+export type UseHitsPerPageProps = HitsPerPageConnectorParams;
+export declare function useHitsPerPage(props: UseHitsPerPageProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/hits-per-page/connectHitsPerPage").HitsPerPageRenderState;

package/dist/es/connectors/useHitsPerPage.js

@@ -0,0 +1,5 @@
+import connectHitsPerPage from "instantsearch.js/es/connectors/hits-per-page/connectHitsPerPage.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useHitsPerPage(props, additionalWidgetProperties) {
+  return useConnector(connectHitsPerPage, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useInfiniteHits.d.ts

@@ -0,0 +1,5 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { BaseHit } from 'instantsearch.js';
+import type { InfiniteHitsConnectorParams } from 'instantsearch.js/es/connectors/infinite-hits/connectInfiniteHits';
+export type UseInfiniteHitsProps<THit extends BaseHit = BaseHit> = InfiniteHitsConnectorParams<THit>;
+export declare function useInfiniteHits<THit extends BaseHit = BaseHit>(props?: UseInfiniteHitsProps<THit>, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<THit>;

package/dist/es/connectors/useInfiniteHits.js

@@ -0,0 +1,5 @@
+import connectInfiniteHits from "instantsearch.js/es/connectors/infinite-hits/connectInfiniteHits.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useInfiniteHits(props, additionalWidgetProperties) {
+  return useConnector(connectInfiniteHits, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useMenu.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { MenuConnectorParams } from 'instantsearch.js/es/connectors/menu/connectMenu';
+export type UseMenuProps = MenuConnectorParams;
+export declare function useMenu(props: UseMenuProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/menu/connectMenu").MenuRenderState;

package/dist/es/connectors/useMenu.js

@@ -0,0 +1,5 @@
+import connectMenu from "instantsearch.js/es/connectors/menu/connectMenu.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useMenu(props, additionalWidgetProperties) {
+  return useConnector(connectMenu, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useNumericMenu.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { NumericMenuConnectorParams } from 'instantsearch.js/es/connectors/numeric-menu/connectNumericMenu';
+export type UseNumericMenuProps = NumericMenuConnectorParams;
+export declare function useNumericMenu(props: UseNumericMenuProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/numeric-menu/connectNumericMenu").NumericMenuRenderState;

package/dist/es/connectors/useNumericMenu.js

@@ -0,0 +1,5 @@
+import connectNumericMenu from "instantsearch.js/es/connectors/numeric-menu/connectNumericMenu.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useNumericMenu(props, additionalWidgetProperties) {
+  return useConnector(connectNumericMenu, props, additionalWidgetProperties);
+}

package/dist/es/connectors/usePagination.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { PaginationConnectorParams } from 'instantsearch.js/es/connectors/pagination/connectPagination';
+export type UsePaginationProps = PaginationConnectorParams;
+export declare function usePagination(props?: UsePaginationProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/pagination/connectPagination").PaginationRenderState;

package/dist/es/connectors/usePagination.js

@@ -0,0 +1,5 @@
+import connectPagination from "instantsearch.js/es/connectors/pagination/connectPagination.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function usePagination(props, additionalWidgetProperties) {
+  return useConnector(connectPagination, props, additionalWidgetProperties);
+}

package/dist/es/connectors/usePoweredBy.d.ts

@@ -0,0 +1,2 @@
+import type { PoweredByRenderState } from 'instantsearch.js/es/connectors/powered-by/connectPoweredBy';
+export declare function usePoweredBy(): PoweredByRenderState;

package/dist/es/connectors/usePoweredBy.js

@@ -0,0 +1,15 @@
+import { safelyRunOnBrowser } from "instantsearch.js/es/lib/utils/index.js";
+export function usePoweredBy() {
+  var hostname = safelyRunOnBrowser(function (_ref) {
+    var _window$location;
+    var window = _ref.window;
+    return ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || '';
+  }, {
+    fallback: function fallback() {
+      return '';
+    }
+  });
+  return {
+    url: "https://www.algolia.com/?utm_source=react-instantsearch&utm_medium=website&utm_content=".concat(hostname, "&utm_campaign=poweredby")
+  };
+}

package/dist/es/connectors/useQueryRules.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { QueryRulesConnectorParams } from 'instantsearch.js/es/connectors/query-rules/connectQueryRules';
+export type UseQueryRulesProps = QueryRulesConnectorParams;
+export declare function useQueryRules(props?: UseQueryRulesProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/query-rules/connectQueryRules").QueryRulesRenderState;

package/dist/es/connectors/useQueryRules.js

@@ -0,0 +1,5 @@
+import connectQueryRules from "instantsearch.js/es/connectors/query-rules/connectQueryRules.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useQueryRules(props, additionalWidgetProperties) {
+  return useConnector(connectQueryRules, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useRange.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { RangeConnectorParams } from 'instantsearch.js/es/connectors/range/connectRange';
+export type UseRangeProps = RangeConnectorParams;
+export declare function useRange(props: UseRangeProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/range/connectRange").RangeRenderState;

package/dist/es/connectors/useRange.js

@@ -0,0 +1,5 @@
+import connectRange from "instantsearch.js/es/connectors/range/connectRange.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useRange(props, additionalWidgetProperties) {
+  return useConnector(connectRange, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useRefinementList.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { RefinementListConnectorParams } from 'instantsearch.js/es/connectors/refinement-list/connectRefinementList';
+export type UseRefinementListProps = RefinementListConnectorParams;
+export declare function useRefinementList(props: UseRefinementListProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/refinement-list/connectRefinementList").RefinementListRenderState;

package/dist/es/connectors/useRefinementList.js

@@ -0,0 +1,5 @@
+import connectRefinementList from "instantsearch.js/es/connectors/refinement-list/connectRefinementList.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useRefinementList(props, additionalWidgetProperties) {
+  return useConnector(connectRefinementList, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useSearchBox.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { SearchBoxConnectorParams } from 'instantsearch.js/es/connectors/search-box/connectSearchBox';
+export type UseSearchBoxProps = SearchBoxConnectorParams;
+export declare function useSearchBox(props?: UseSearchBoxProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/search-box/connectSearchBox").SearchBoxRenderState;

package/dist/es/connectors/useSearchBox.js

@@ -0,0 +1,5 @@
+import connectSearchBox from "instantsearch.js/es/connectors/search-box/connectSearchBox.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useSearchBox(props, additionalWidgetProperties) {
+  return useConnector(connectSearchBox, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useSortBy.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { SortByConnectorParams } from 'instantsearch.js/es/connectors/sort-by/connectSortBy';
+export type UseSortByProps = SortByConnectorParams;
+export declare function useSortBy(props: UseSortByProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/sort-by/connectSortBy").SortByRenderState;

package/dist/es/connectors/useSortBy.js

@@ -0,0 +1,5 @@
+import connectSortBy from "instantsearch.js/es/connectors/sort-by/connectSortBy.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useSortBy(props, additionalWidgetProperties) {
+  return useConnector(connectSortBy, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useStats.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { StatsConnectorParams } from 'instantsearch.js/es/connectors/stats/connectStats';
+export type UseStatsProps = StatsConnectorParams;
+export declare function useStats(props?: UseStatsProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/stats/connectStats").StatsRenderState;

package/dist/es/connectors/useStats.js

@@ -0,0 +1,5 @@
+import connectStats from "instantsearch.js/es/connectors/stats/connectStats.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useStats(props, additionalWidgetProperties) {
+  return useConnector(connectStats, props, additionalWidgetProperties);
+}

package/dist/es/connectors/useToggleRefinement.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { ToggleRefinementConnectorParams } from 'instantsearch.js/es/connectors/toggle-refinement/connectToggleRefinement';
+export type UseToggleRefinementProps = ToggleRefinementConnectorParams;
+export declare function useToggleRefinement(props: UseToggleRefinementProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState;

package/dist/es/connectors/useToggleRefinement.js

@@ -0,0 +1,5 @@
+import connectToggleRefinement from "instantsearch.js/es/connectors/toggle-refinement/connectToggleRefinement.js";
+import { useConnector } from "../hooks/useConnector.js";
+export function useToggleRefinement(props, additionalWidgetProperties) {
+  return useConnector(connectToggleRefinement, props, additionalWidgetProperties);
+}

package/dist/es/hooks/useConnector.d.ts

@@ -0,0 +1,3 @@
+import type { Connector, Widget, WidgetDescription } from 'instantsearch.js';
+export type AdditionalWidgetProperties = Partial<Widget<WidgetDescription>>;
+export declare function useConnector<TProps extends Record<string, unknown>, TDescription extends WidgetDescription>(connector: Connector<TDescription, TProps>, props?: TProps, additionalWidgetProperties?: AdditionalWidgetProperties): TDescription['renderState'];

package/dist/es/hooks/useConnector.js

@@ -0,0 +1,130 @@
+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 = ["instantSearchInstance", "widgetParams"],
+  _excluded2 = ["widgetParams"];
+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 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 { useMemo, useRef, useState } from 'react';
+import { dequal } from "../lib/dequal.js";
+import { getIndexSearchResults } from "../lib/getIndexSearchResults.js";
+import { useIndexContext } from "../lib/useIndexContext.js";
+import { useInstantSearchContext } from "../lib/useInstantSearchContext.js";
+import { useInstantSearchServerContext } from "../lib/useInstantSearchServerContext.js";
+import { useStableValue } from "../lib/useStableValue.js";
+import { useWidget } from "../lib/useWidget.js";
+export function useConnector(connector) {
+  var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var additionalWidgetProperties = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  var serverContext = useInstantSearchServerContext();
+  var search = useInstantSearchContext();
+  var parentIndex = useIndexContext();
+  var stableProps = useStableValue(props);
+  var stableAdditionalWidgetProperties = useStableValue(additionalWidgetProperties);
+  var shouldSetStateRef = useRef(true);
+  var previousRenderStateRef = useRef(null);
+  var previousStatusRef = useRef(search.status);
+  var widget = useMemo(function () {
+    var createWidget = connector(function (connectorState, isFirstRender) {
+      // We skip the `init` widget render because:
+      // - We rely on `getWidgetRenderState` to compute the initial state before
+      //   the InstantSearch.js lifecycle starts.
+      // - It prevents UI flashes when updating the widget props.
+      if (isFirstRender) {
+        shouldSetStateRef.current = true;
+        return;
+      }
+
+      // There are situations where InstantSearch.js may render widgets slightly
+      // after they're removed by React, and thus try to update the React state
+      // on unmounted components. React 16 and 17 consider them as memory leaks
+      // and display a warning.
+      // This happens in <DynamicWidgets> when `attributesToRender` contains a
+      // value without an attribute previously mounted. React will unmount the
+      // component controlled by that attribute, but InstantSearch.js will stay
+      // unaware of this change until the render pass finishes, and therefore
+      // notifies of a state change.
+      // This ref lets us track this situation and ignore these state updates.
+      if (shouldSetStateRef.current) {
+        var instantSearchInstance = connectorState.instantSearchInstance,
+          widgetParams = connectorState.widgetParams,
+          renderState = _objectWithoutProperties(connectorState, _excluded);
+
+        // We only update the state when a widget render state param changes,
+        // except for functions. We ignore function reference changes to avoid
+        // infinite loops. It's safe to omit them because they get updated
+        // every time another render param changes.
+        if (!dequal(renderState, previousRenderStateRef.current, function (a, b) {
+          return (a === null || a === void 0 ? void 0 : a.constructor) === Function && (b === null || b === void 0 ? void 0 : b.constructor) === Function;
+        }) || instantSearchInstance.status !== previousStatusRef.current) {
+          // eslint-disable-next-line @typescript-eslint/no-use-before-define
+          setState(renderState);
+          previousRenderStateRef.current = renderState;
+          previousStatusRef.current = instantSearchInstance.status;
+        }
+      }
+    }, function () {
+      // We'll ignore the next state update until we know for sure that
+      // InstantSearch.js re-inits the component.
+      shouldSetStateRef.current = false;
+    });
+    return _objectSpread(_objectSpread({}, createWidget(stableProps)), stableAdditionalWidgetProperties);
+  }, [connector, stableProps, stableAdditionalWidgetProperties]);
+  var _useState = useState(function () {
+      if (widget.getWidgetRenderState) {
+        var _widget$getWidgetSear;
+        // The helper exists because we've started InstantSearch.
+        var helper = parentIndex.getHelper();
+        var uiState = parentIndex.getWidgetUiState({})[parentIndex.getIndexId()];
+        helper.state = ((_widget$getWidgetSear = widget.getWidgetSearchParameters) === null || _widget$getWidgetSear === void 0 ? void 0 : _widget$getWidgetSear.call(widget, helper.state, {
+          uiState: uiState
+        })) || helper.state;
+        var _getIndexSearchResult = getIndexSearchResults(parentIndex),
+          results = _getIndexSearchResult.results,
+          scopedResults = _getIndexSearchResult.scopedResults;
+
+        // We get the widget render state by providing the same parameters as
+        // InstantSearch provides to the widget's `render` method.
+        // See https://github.com/algolia/instantsearch.js/blob/019cd18d0de6dd320284aa4890541b7fe2198c65/src/widgets/index/index.ts#L604-L617
+        var _widget$getWidgetRend = widget.getWidgetRenderState({
+            helper: helper,
+            parent: parentIndex,
+            instantSearchInstance: search,
+            results: results,
+            scopedResults: scopedResults,
+            state: helper.state,
+            renderState: search.renderState,
+            templatesConfig: search.templatesConfig,
+            createURL: parentIndex.createURL,
+            searchMetadata: {
+              isSearchStalled: search.status === 'stalled'
+            },
+            status: search.status,
+            error: search.error
+          }),
+          widgetParams = _widget$getWidgetRend.widgetParams,
+          renderState = _objectWithoutProperties(_widget$getWidgetRend, _excluded2);
+        return renderState;
+      }
+      return {};
+    }),
+    _useState2 = _slicedToArray(_useState, 2),
+    state = _useState2[0],
+    setState = _useState2[1];
+  useWidget({
+    widget: widget,
+    parentIndex: parentIndex,
+    props: stableProps,
+    shouldSsr: Boolean(serverContext)
+  });
+  return state;
+}

package/dist/es/hooks/useInstantSearch.d.ts

@@ -0,0 +1,32 @@
+import type { SearchResultsApi } from '../lib/useSearchResults';
+import type { SearchStateApi } from '../lib/useSearchState';
+import type { InstantSearch, Middleware, UiState } from 'instantsearch.js';
+export type InstantSearchApi<TUiState extends UiState = UiState> = SearchStateApi<TUiState> & SearchResultsApi & {
+    /**
+     * Adds middlewares to InstantSearch. It returns its own cleanup function.
+     */
+    addMiddlewares: (...middlewares: Middleware[]) => () => void;
+    /**
+     * Clears the search client’s cache and performs a new search.
+     *
+     * This is useful to update the results once an indexing operation has finished.
+     */
+    refresh: InstantSearch['refresh'];
+    /**
+     * The status of the search happening.
+     */
+    status: InstantSearch['status'];
+    /**
+     * The error that occurred during the search.
+     *
+     * This is only valid when status is 'error'.
+     */
+    error: InstantSearch['error'];
+};
+export type UseInstantSearchProps = {
+    /**
+     * catch any error happening in the search lifecycle and handle it with this hook.
+     */
+    catchError?: boolean;
+};
+export declare function useInstantSearch<TUiState extends UiState = UiState>({ catchError, }?: UseInstantSearchProps): InstantSearchApi<TUiState>;

package/dist/es/hooks/useInstantSearch.js

@@ -0,0 +1,52 @@
+import { useCallback } from 'react';
+import { useInstantSearchContext } from "../lib/useInstantSearchContext.js";
+import { useIsomorphicLayoutEffect } from "../lib/useIsomorphicLayoutEffect.js";
+import { useSearchResults } from "../lib/useSearchResults.js";
+import { useSearchState } from "../lib/useSearchState.js";
+export function useInstantSearch() {
+  var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    catchError = _ref.catchError;
+  var search = useInstantSearchContext();
+  var _useSearchState = useSearchState(),
+    uiState = _useSearchState.uiState,
+    setUiState = _useSearchState.setUiState,
+    indexUiState = _useSearchState.indexUiState,
+    setIndexUiState = _useSearchState.setIndexUiState;
+  var _useSearchResults = useSearchResults(),
+    results = _useSearchResults.results,
+    scopedResults = _useSearchResults.scopedResults;
+  var addMiddlewares = useCallback(function () {
+    for (var _len = arguments.length, middlewares = new Array(_len), _key = 0; _key < _len; _key++) {
+      middlewares[_key] = arguments[_key];
+    }
+    search.use.apply(search, middlewares);
+    return function () {
+      search.unuse.apply(search, middlewares);
+    };
+  }, [search]);
+  var refresh = useCallback(function () {
+    search.refresh();
+  }, [search]);
+  useIsomorphicLayoutEffect(function () {
+    if (catchError) {
+      var onError = function onError() {};
+      search.addListener('error', onError);
+      return function () {
+        return search.removeListener('error', onError);
+      };
+    }
+    return function () {};
+  }, [search, catchError]);
+  return {
+    results: results,
+    scopedResults: scopedResults,
+    uiState: uiState,
+    setUiState: setUiState,
+    indexUiState: indexUiState,
+    setIndexUiState: setIndexUiState,
+    addMiddlewares: addMiddlewares,
+    refresh: refresh,
+    status: search.status,
+    error: search.error
+  };
+}

package/dist/es/index.d.ts

@@ -0,0 +1,31 @@
+export { default as version } from './version';
+export * from './components/Configure';
+export * from './components/DynamicWidgets';
+export * from './components/Index';
+export * from './components/InstantSearch';
+export * from './components/InstantSearchServerContext';
+export * from './components/InstantSearchSSRProvider';
+export * from './connectors/useBreadcrumb';
+export * from './connectors/useClearRefinements';
+export * from './connectors/useConfigure';
+export * from './connectors/useCurrentRefinements';
+export * from './connectors/useDynamicWidgets';
+export * from './connectors/useGeoSearch';
+export * from './connectors/useHierarchicalMenu';
+export * from './connectors/useHits';
+export * from './connectors/useHitsPerPage';
+export * from './connectors/useInfiniteHits';
+export * from './connectors/useMenu';
+export * from './connectors/useNumericMenu';
+export * from './connectors/usePagination';
+export * from './connectors/usePoweredBy';
+export * from './connectors/useQueryRules';
+export * from './connectors/useRange';
+export * from './connectors/useRefinementList';
+export * from './connectors/useSearchBox';
+export * from './connectors/useSortBy';
+export * from './connectors/useStats';
+export * from './connectors/useToggleRefinement';
+export * from './hooks/useConnector';
+export * from './hooks/useInstantSearch';
+export * from './server';

package/dist/es/index.js

@@ -1,86 +1,31 @@
-// Core
-export { default as createConnector } from "./core/createConnector.js";
-export { instantSearchContext, InstantSearchConsumer, InstantSearchProvider } from "./core/context.js";
-
-// Utils
-// @ts-ignore not yet typed
-export { HIGHLIGHT_TAGS } from "./core/highlight.js";
-// @ts-ignore not yet typed
-export { default as version } from "./core/version.js";
-// @ts-ignore not yet typed
-export { default as translatable } from "./core/translatable.js";
-
-// Widgets
-// @ts-ignore not yet typed
-export { default as Configure } from "./widgets/Configure.js";
-export { default as ExperimentalConfigureRelatedItems } from "./widgets/ConfigureRelatedItems.js";
-import { default as DynamicWidgets } from "./widgets/DynamicWidgets.js";
-/** @deprecated use DynamicWidgets */
-var ExperimentalDynamicWidgets = DynamicWidgets;
-export { ExperimentalDynamicWidgets, DynamicWidgets };
-export { default as QueryRuleContext } from "./widgets/QueryRuleContext.js";
-export { default as Index } from "./widgets/Index.js";
-export { default as InstantSearch } from "./widgets/InstantSearch.js";
-
-// Connectors
-// @ts-ignore not yet typed
-export { default as connectAutoComplete } from "./connectors/connectAutoComplete.js";
-// @ts-ignore not yet typed
-export { default as connectBreadcrumb } from "./connectors/connectBreadcrumb.js";
-// @ts-ignore not yet typed
-export { default as connectConfigure } from "./connectors/connectConfigure.js";
-export { default as EXPERIMENTAL_connectConfigureRelatedItems } from "./connectors/connectConfigureRelatedItems.js";
-// @ts-ignore not yet typed
-export { default as connectCurrentRefinements } from "./connectors/connectCurrentRefinements.js";
-import { default as connectDynamicWidgets } from "./connectors/connectDynamicWidgets.js";
-/** @deprecated use connectDynamicWidgets */
-var EXPERIMENTAL_connectDynamicWidgets = connectDynamicWidgets;
-export { connectDynamicWidgets, EXPERIMENTAL_connectDynamicWidgets };
-
-// @ts-ignore not yet typed
-export { default as connectGeoSearch } from "./connectors/connectGeoSearch.js";
-// @ts-ignore not yet typed
-export { default as connectHierarchicalMenu } from "./connectors/connectHierarchicalMenu.js";
-// @ts-ignore not yet typed
-export { default as connectHighlight } from "./connectors/connectHighlight.js";
-// @ts-ignore not yet typed
-export { default as connectHits } from "./connectors/connectHits.js";
-// @ts-ignore not yet typed
-export { default as connectHitsPerPage } from "./connectors/connectHitsPerPage.js";
-// @ts-ignore not yet typed
-export { default as connectInfiniteHits } from "./connectors/connectInfiniteHits.js";
-// @ts-ignore not yet typed
-export { default as connectMenu } from "./connectors/connectMenu.js";
-// @ts-ignore not yet typed
-export { default as connectNumericMenu } from "./connectors/connectNumericMenu.js";
-// @ts-ignore not yet typed
-export { default as connectPagination } from "./connectors/connectPagination.js";
-// @ts-ignore not yet typed
-export { default as connectPoweredBy } from "./connectors/connectPoweredBy.js";
-// @ts-ignore not yet typed
-export { default as connectQueryRules } from "./connectors/connectQueryRules.js";
-// @ts-ignore not yet typed
-export { default as connectRange } from "./connectors/connectRange.js";
-// @ts-ignore not yet typed
-export { default as connectRefinementList } from "./connectors/connectRefinementList.js";
-// @ts-ignore not yet typed
-export { default as connectScrollTo } from "./connectors/connectScrollTo.js";
-// @ts-ignore not yet typed
-export { default as connectSearchBox } from "./connectors/connectSearchBox.js";
-// @ts-ignore not yet typed
-export { default as connectRelevantSort } from "./connectors/connectRelevantSort.js";
-// @ts-ignore not yet typed
-export { default as connectSortBy } from "./connectors/connectSortBy.js";
-// @ts-ignore not yet typed
-export { default as connectStateResults } from "./connectors/connectStateResults.js";
-// @ts-ignore not yet typed
-export { default as connectStats } from "./connectors/connectStats.js";
-// @ts-ignore not yet typed
-export { default as connectToggleRefinement } from "./connectors/connectToggleRefinement.js";
-// @ts-ignore not yet typed
-export { default as connectHitInsights } from "./connectors/connectHitInsights.js";
-// @ts-ignore not yet typed
-export { default as connectVoiceSearch } from "./connectors/connectVoiceSearch.js";
-
-// Types
-export * from "./types/index.js";
+export { default as version } from "./version.js";
+export * from "./components/Configure.js";
+export * from "./components/DynamicWidgets.js";
+export * from "./components/Index.js";
+export * from "./components/InstantSearch.js";
+export * from "./components/InstantSearchServerContext.js";
+export * from "./components/InstantSearchSSRProvider.js";
+export * from "./connectors/useBreadcrumb.js";
+export * from "./connectors/useClearRefinements.js";
+export * from "./connectors/useConfigure.js";
+export * from "./connectors/useCurrentRefinements.js";
+export * from "./connectors/useDynamicWidgets.js";
+export * from "./connectors/useGeoSearch.js";
+export * from "./connectors/useHierarchicalMenu.js";
+export * from "./connectors/useHits.js";
+export * from "./connectors/useHitsPerPage.js";
+export * from "./connectors/useInfiniteHits.js";
+export * from "./connectors/useMenu.js";
+export * from "./connectors/useNumericMenu.js";
+export * from "./connectors/usePagination.js";
+export * from "./connectors/usePoweredBy.js";
+export * from "./connectors/useQueryRules.js";
+export * from "./connectors/useRange.js";
+export * from "./connectors/useRefinementList.js";
+export * from "./connectors/useSearchBox.js";
+export * from "./connectors/useSortBy.js";
+export * from "./connectors/useStats.js";
+export * from "./connectors/useToggleRefinement.js";
+export * from "./hooks/useConnector.js";
+export * from "./hooks/useInstantSearch.js";
+export * from "./server/index.js";

package/dist/es/lib/IndexContext.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { IndexWidget } from 'instantsearch.js/es/widgets/index/index';
+export declare const IndexContext: import("react").Context<IndexWidget | null>;

package/dist/es/lib/IndexContext.js

@@ -0,0 +1,5 @@
+import { createContext } from 'react';
+export var IndexContext = /*#__PURE__*/createContext(null);
+if (process.env.NODE_ENV === 'development') {
+  IndexContext.displayName = 'Index';
+}

package/dist/es/lib/InstantSearchContext.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { InstantSearch } from 'instantsearch.js';
+export declare const InstantSearchContext: import("react").Context<InstantSearch<import("instantsearch.js").UiState, import("instantsearch.js").UiState> | null>;

package/dist/es/lib/InstantSearchContext.js

@@ -0,0 +1,5 @@
+import { createContext } from 'react';
+export var InstantSearchContext = /*#__PURE__*/createContext(null);
+if (process.env.NODE_ENV === 'development') {
+  InstantSearchContext.displayName = 'InstantSearch';
+}

package/dist/es/lib/InstantSearchSSRContext.d.ts

@@ -0,0 +1,8 @@
+import type { InstantSearchServerState } from '../components/InstantSearchSSRProvider';
+import type { InternalInstantSearch } from './useInstantSearchApi';
+import type { UiState } from 'instantsearch.js';
+import type { MutableRefObject } from 'react';
+export type InstantSearchSSRContextApi<TUiState extends UiState, TRouteState = TUiState> = InstantSearchServerState & {
+    ssrSearchRef: MutableRefObject<InternalInstantSearch<TUiState, TRouteState> | null>;
+};
+export declare const InstantSearchSSRContext: import("react").Context<Partial<InstantSearchSSRContextApi<UiState, UiState>> | null>;

package/dist/es/lib/InstantSearchSSRContext.js

@@ -0,0 +1,5 @@
+import { createContext } from 'react';
+export var InstantSearchSSRContext = /*#__PURE__*/createContext(null);
+if (process.env.NODE_ENV === 'development') {
+  InstantSearchSSRContext.displayName = 'InstantSearchSSR';
+}