react-instantsearch-core 6.40.4 → 7.0.0

package/dist/cjs/connectors/useToggleRefinement.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useToggleRefinement = useToggleRefinement;
+var _connectToggleRefinement = _interopRequireDefault(require("instantsearch.js/cjs/connectors/toggle-refinement/connectToggleRefinement"));
+var _useConnector = require("../hooks/useConnector");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function useToggleRefinement(props, additionalWidgetProperties) {
+  return (0, _useConnector.useConnector)(_connectToggleRefinement.default, props, additionalWidgetProperties);
+}

package/dist/cjs/hooks/useConnector.js

@@ -0,0 +1,136 @@
+"use strict";
+
+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); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useConnector = useConnector;
+var _react = require("react");
+var _dequal = require("../lib/dequal");
+var _getIndexSearchResults = require("../lib/getIndexSearchResults");
+var _useIndexContext = require("../lib/useIndexContext");
+var _useInstantSearchContext = require("../lib/useInstantSearchContext");
+var _useInstantSearchServerContext = require("../lib/useInstantSearchServerContext");
+var _useStableValue = require("../lib/useStableValue");
+var _useWidget = require("../lib/useWidget");
+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; }
+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 = (0, _useInstantSearchServerContext.useInstantSearchServerContext)();
+  var search = (0, _useInstantSearchContext.useInstantSearchContext)();
+  var parentIndex = (0, _useIndexContext.useIndexContext)();
+  var stableProps = (0, _useStableValue.useStableValue)(props);
+  var stableAdditionalWidgetProperties = (0, _useStableValue.useStableValue)(additionalWidgetProperties);
+  var shouldSetStateRef = (0, _react.useRef)(true);
+  var previousRenderStateRef = (0, _react.useRef)(null);
+  var previousStatusRef = (0, _react.useRef)(search.status);
+  var widget = (0, _react.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 (!(0, _dequal.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 = (0, _react.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 = (0, _getIndexSearchResults.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];
+  (0, _useWidget.useWidget)({
+    widget: widget,
+    parentIndex: parentIndex,
+    props: stableProps,
+    shouldSsr: Boolean(serverContext)
+  });
+  return state;
+}

package/dist/cjs/hooks/useInstantSearch.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useInstantSearch = useInstantSearch;
+var _react = require("react");
+var _useInstantSearchContext = require("../lib/useInstantSearchContext");
+var _useIsomorphicLayoutEffect = require("../lib/useIsomorphicLayoutEffect");
+var _useSearchResults2 = require("../lib/useSearchResults");
+var _useSearchState2 = require("../lib/useSearchState");
+function useInstantSearch() {
+  var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    catchError = _ref.catchError;
+  var search = (0, _useInstantSearchContext.useInstantSearchContext)();
+  var _useSearchState = (0, _useSearchState2.useSearchState)(),
+    uiState = _useSearchState.uiState,
+    setUiState = _useSearchState.setUiState,
+    indexUiState = _useSearchState.indexUiState,
+    setIndexUiState = _useSearchState.setIndexUiState;
+  var _useSearchResults = (0, _useSearchResults2.useSearchResults)(),
+    results = _useSearchResults.results,
+    scopedResults = _useSearchResults.scopedResults;
+  var addMiddlewares = (0, _react.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 = (0, _react.useCallback)(function () {
+    search.refresh();
+  }, [search]);
+  (0, _useIsomorphicLayoutEffect.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
+  };
+}