instantsearch.js 4.57.0 → 4.58.0

package/es/components/InternalHighlight/InternalHighlight.d.ts

@@ -1 +1 @@
-export declare const InternalHighlight: ({ parts, highlightedTagName, nonHighlightedTagName, separator, className, classNames, ...props }: import("@algolia/ui-components-highlight-vdom").HighlightProps) => JSX.Element;
+export declare const InternalHighlight: (userProps: import("@algolia/ui-components-highlight-vdom").HighlightProps) => JSX.Element;

package/es/lib/InstantSearch.d.ts

@@ -96,8 +96,21 @@ export type InstantSearchOptions<TUiState extends UiState = UiState, TRouteState
      * @deprecated This property will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
      */
     insightsClient?: AlgoliaInsightsClient;
+    future?: {
+        /**
+         * Changes the way `dispose` is used in InstantSearch lifecycle.
+         *
+         * If `false` (by default), each widget unmounting will remove its state as well, even if there are multiple widgets reading that UI State.
+         *
+         * If `true`, each widget unmounting will only remove its own state if it's the last of its type. This allows for dynamically adding and removing widgets without losing their state.
+         *
+         * @default false
+         */
+        preserveSharedStateOnUnmount?: boolean;
+    };
 };
 export type InstantSearchStatus = 'idle' | 'loading' | 'stalled' | 'error';
+export declare const INSTANTSEARCH_FUTURE_DEFAULTS: Required<InstantSearchOptions['future']>;
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -108,6 +121,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     indexName: string;
     insightsClient: AlgoliaInsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
+    future: NonNullable<InstantSearchOptions<TUiState>['future']>;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;

package/es/lib/InstantSearch.js

@@ -36,6 +36,10 @@ function defaultCreateURL() {
 /**
  * Global options for an InstantSearch instance.
  */
+export var INSTANTSEARCH_FUTURE_DEFAULTS = {
+  preserveSharedStateOnUnmount: false
+};
+
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -45,6 +49,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
   _inherits(InstantSearch, _EventEmitter);
   var _super = _createSuper(InstantSearch);
   function InstantSearch(options) {
+    var _options$future2;
     var _this;
     _classCallCheck(this, InstantSearch);
     _this = _super.call(this);
@@ -54,6 +59,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _defineProperty(_assertThisInitialized(_this), "indexName", void 0);
     _defineProperty(_assertThisInitialized(_this), "insightsClient", void 0);
     _defineProperty(_assertThisInitialized(_this), "onStateChange", null);
+    _defineProperty(_assertThisInitialized(_this), "future", void 0);
     _defineProperty(_assertThisInitialized(_this), "helper", void 0);
     _defineProperty(_assertThisInitialized(_this), "mainHelper", void 0);
     _defineProperty(_assertThisInitialized(_this), "mainIndex", void 0);
@@ -126,7 +132,9 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       _options$insightsClie = options.insightsClient,
       insightsClient = _options$insightsClie === void 0 ? null : _options$insightsClie,
       _options$onStateChang = options.onStateChange,
-      onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang;
+      onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang,
+      _options$future = options.future,
+      future = _options$future === void 0 ? _objectSpread(_objectSpread({}, INSTANTSEARCH_FUTURE_DEFAULTS), options.future || {}) : _options$future;
     if (searchClient === null) {
       throw new Error(withUsage('The `searchClient` option is required.'));
     }
@@ -143,7 +151,14 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     process.env.NODE_ENV === 'development' ? warning(!options.searchParameters, "The `searchParameters` option is deprecated and will not be supported in InstantSearch.js 4.x.\n\nYou can replace it with the `configure` widget:\n\n```\nsearch.addWidgets([\n  configure(".concat(JSON.stringify(options.searchParameters, null, 2), ")\n]);\n```\n\nSee ").concat(createDocumentationLink({
       name: 'configure'
     }))) : void 0;
+    if (process.env.NODE_ENV === 'development' && ((_options$future2 = options.future) === null || _options$future2 === void 0 ? void 0 : _options$future2.preserveSharedStateOnUnmount) === undefined) {
+      // eslint-disable-next-line no-console
+      console.info("Starting from the next major version, InstantSearch will change how widgets state is preserved when they are removed. InstantSearch will keep the state of unmounted widgets to be usable by other widgets with the same attribute.\n\nWe recommend setting `future.preserveSharedStateOnUnmount` to true to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to false.\n\nSee documentation: ".concat(createDocumentationLink({
+        name: 'instantsearch'
+      }), "#widget-param-future\n          "));
+    }
     _this.client = searchClient;
+    _this.future = future;
     _this.insightsClient = insightsClient;
     _this.indexName = indexName;
     _this.helper = null;

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.57.0";
+declare const _default: "4.58.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.57.0';
+export default '4.58.0';

package/es/middlewares/createInsightsMiddleware.js

@@ -135,7 +135,7 @@ export function createInsightsMiddleware() {
       },
       started: function started() {
         insightsClient('addAlgoliaAgent', 'insights-middleware');
-        helper = instantSearchInstance.helper;
+        helper = instantSearchInstance.mainHelper;
         initialParameters = {
           userToken: helper.state.userToken,
           clickAnalytics: helper.state.clickAnalytics

package/es/widgets/index/index.js

@@ -207,7 +207,7 @@ var index = function index(widgetParams) {
         return widgets.indexOf(widget) === -1;
       });
       if (localInstantSearchInstance && Boolean(widgets.length)) {
-        var _nextState = widgets.reduce(function (state, widget) {
+        var cleanedState = widgets.reduce(function (state, widget) {
           // the `dispose` method exists at this point we already assert it
           var next = widget.dispose({
             helper: helper,
@@ -216,14 +216,23 @@ var index = function index(widgetParams) {
           });
           return next || state;
         }, helper.state);
+        var newState = localInstantSearchInstance.future.preserveSharedStateOnUnmount ? getLocalWidgetsSearchParameters(localWidgets, {
+          uiState: localUiState,
+          initialSearchParameters: new algoliasearchHelper.SearchParameters({
+            index: this.getIndexName()
+          })
+        }) : getLocalWidgetsSearchParameters(localWidgets, {
+          uiState: getLocalWidgetsUiState(localWidgets, {
+            searchParameters: cleanedState,
+            helper: helper
+          }),
+          initialSearchParameters: cleanedState
+        });
         localUiState = getLocalWidgetsUiState(localWidgets, {
-          searchParameters: _nextState,
+          searchParameters: newState,
           helper: helper
         });
-        helper.setState(getLocalWidgetsSearchParameters(localWidgets, {
-          uiState: localUiState,
-          initialSearchParameters: _nextState
-        }));
+        helper.setState(newState);
         if (localWidgets.length) {
           localInstantSearchInstance.scheduleSearch();
         }
@@ -289,7 +298,7 @@ var index = function index(widgetParams) {
         return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
       };
       derivedHelper = mainHelper.derive(function () {
-        return mergeSearchParameters.apply(void 0, _toConsumableArray(resolveSearchParameters(_this3)));
+        return mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray(resolveSearchParameters(_this3))));
       });
       var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
       if (indexInitialResults) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.57.0",
+  "version": "4.58.0",
   "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",
@@ -27,8 +27,8 @@
   ],
   "dependencies": {
     "@algolia/events": "^4.0.1",
-    "@algolia/ui-components-highlight-vdom": "^1.2.1",
-    "@algolia/ui-components-shared": "^1.2.1",
+    "@algolia/ui-components-highlight-vdom": "^1.2.2",
+    "@algolia/ui-components-shared": "^1.2.2",
     "@types/dom-speech-recognition": "^0.0.1",
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.26.0",
-    "@instantsearch/tests": "1.26.0",
-    "@instantsearch/testutils": "1.15.0",
+    "@instantsearch/mocks": "1.27.0",
+    "@instantsearch/tests": "1.27.0",
+    "@instantsearch/testutils": "1.16.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -65,5 +65,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.41.5"
   },
-  "gitHead": "b2196f01f03c6bea37a3aa048e4e5b45a9bbf33d"
+  "gitHead": "d21e0ed006139e5635df70d7a4caf0c99ab85f5a"
 }