instantsearch.js 4.56.4 → 4.56.5

package/es/connectors/breadcrumb/connectBreadcrumb.js

@@ -67,6 +67,7 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(_ref2) {
+        var _this = this;
         var helper = _ref2.helper,
           createURL = _ref2.createURL,
           results = _ref2.results,
@@ -90,7 +91,12 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
         var items = getItems();
         if (!connectorState.createURL) {
           connectorState.createURL = function (facetValue) {
-            return createURL(getRefinedState(helper.state, facetValue));
+            return createURL(function (uiState) {
+              return _this.getWidgetUiState(uiState, {
+                searchParameters: getRefinedState(helper.state, facetValue),
+                helper: helper
+              });
+            });
           };
         }
         if (!connectorState.refine) {
@@ -106,18 +112,39 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
           widgetParams: widgetParams
         };
       },
-      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters) {
+      getWidgetUiState: function getWidgetUiState(uiState, _ref3) {
+        var searchParameters = _ref3.searchParameters;
+        var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
+        if (!path.length) {
+          return uiState;
+        }
+        return _objectSpread(_objectSpread({}, uiState), {}, {
+          hierarchicalMenu: _objectSpread(_objectSpread({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
+        });
+      },
+      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref4) {
+        var uiState = _ref4.uiState;
+        var values = uiState.hierarchicalMenu && uiState.hierarchicalMenu[hierarchicalFacetName];
+        if (searchParameters.isConjunctiveFacet(hierarchicalFacetName) || searchParameters.isDisjunctiveFacet(hierarchicalFacetName)) {
+          process.env.NODE_ENV === 'development' ? warning(false, "HierarchicalMenu: Attribute \"".concat(hierarchicalFacetName, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this HierarchicalMenu widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         if (searchParameters.isHierarchicalFacet(hierarchicalFacetName)) {
           var facet = searchParameters.getHierarchicalFacetByName(hierarchicalFacetName);
           process.env.NODE_ENV === 'development' ? warning(isEqual(facet.attributes, attributes) && facet.separator === separator && facet.rootPath === rootPath, 'Using Breadcrumb and HierarchicalMenu on the same facet with different options overrides the configuration of the HierarchicalMenu.') : void 0;
-          return searchParameters;
         }
-        return searchParameters.addHierarchicalFacet({
+        var withFacetConfiguration = searchParameters.removeHierarchicalFacet(hierarchicalFacetName).addHierarchicalFacet({
           name: hierarchicalFacetName,
           attributes: attributes,
           separator: separator,
           rootPath: rootPath
         });
+        if (!values) {
+          return withFacetConfiguration.setQueryParameters({
+            hierarchicalFacetsRefinements: _objectSpread(_objectSpread({}, withFacetConfiguration.hierarchicalFacetsRefinements), {}, _defineProperty({}, hierarchicalFacetName, []))
+          });
+        }
+        return withFacetConfiguration.addHierarchicalFacetRefinement(hierarchicalFacetName, values.join(separator));
       }
     };
   };

package/es/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -130,6 +130,7 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(_ref4) {
+        var _this = this;
         var results = _ref4.results,
           state = _ref4.state,
           createURL = _ref4.createURL,
@@ -139,9 +140,14 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
         var canToggleShowMore = false;
 
         // Bind createURL to this specific attribute
-        function _createURL(facetValue) {
-          return createURL(state.resetPage().toggleFacetRefinement(hierarchicalFacetName, facetValue));
-        }
+        var _createURL = function _createURL(facetValue) {
+          return createURL(function (uiState) {
+            return _this.getWidgetUiState(uiState, {
+              searchParameters: state.resetPage().toggleFacetRefinement(hierarchicalFacetName, facetValue),
+              helper: helper
+            });
+          });
+        };
         if (!sendEvent) {
           sendEvent = createSendEventForFacet({
             instantSearchInstance: instantSearchInstance,

package/es/connectors/hits-per-page/connectHitsPerPage.d.ts

@@ -1,4 +1,4 @@
-import type { Connector, TransformItems, WidgetRenderState } from '../../types';
+import type { Connector, TransformItems, CreateURL, WidgetRenderState } from '../../types';
 export type HitsPerPageRenderStateItem = {
     /**
      * Label to display in the option.
@@ -44,6 +44,10 @@ export type HitsPerPageRenderState = {
      * Array of objects defining the different values and labels.
      */
     items: HitsPerPageRenderStateItem[];
+    /**
+     * Creates the URL for a single item name in the list.
+     */
+    createURL: CreateURL<HitsPerPageConnectorParamsItem['value']>;
     /**
      * Sets the number of hits per page and triggers a search.
      */

package/es/connectors/hits-per-page/connectHitsPerPage.js

@@ -55,9 +55,16 @@ var connectHitsPerPage = function connectHitsPerPage(renderFn) {
       },
       createURLFactory: function createURLFactory(_ref3) {
         var state = _ref3.state,
-          createURL = _ref3.createURL;
+          createURL = _ref3.createURL,
+          getWidgetUiState = _ref3.getWidgetUiState,
+          helper = _ref3.helper;
         return function (value) {
-          return createURL(state.resetPage().setQueryParameter('hitsPerPage', !value && value !== 0 ? undefined : value));
+          return createURL(function (uiState) {
+            return getWidgetUiState(uiState, {
+              searchParameters: state.resetPage().setQueryParameter('hitsPerPage', !value && value !== 0 ? undefined : value),
+              helper: helper
+            });
+          });
         };
       }
     };
@@ -112,7 +119,9 @@ var connectHitsPerPage = function connectHitsPerPage(renderFn) {
           refine: connectorState.getRefine(helper),
           createURL: connectorState.createURLFactory({
             state: state,
-            createURL: createURL
+            createURL: createURL,
+            getWidgetUiState: this.getWidgetUiState,
+            helper: helper
           }),
           hasNoResults: !canRefine,
           canRefine: canRefine,

package/es/connectors/menu/connectMenu.js

@@ -97,6 +97,7 @@ var connectMenu = function connectMenu(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(renderOptions) {
+        var _this = this;
         var results = renderOptions.results,
           createURL = renderOptions.createURL,
           instantSearchInstance = renderOptions.instantSearchInstance,
@@ -113,7 +114,12 @@ var connectMenu = function connectMenu(renderFn) {
         }
         if (!_createURL) {
           _createURL = function _createURL(facetValue) {
-            return createURL(helper.state.resetPage().toggleFacetRefinement(attribute, facetValue));
+            return createURL(function (uiState) {
+              return _this.getWidgetUiState(uiState, {
+                searchParameters: helper.state.resetPage().toggleFacetRefinement(attribute, facetValue),
+                helper: helper
+              });
+            });
           };
         }
         if (!_refine) {

package/es/connectors/numeric-menu/connectNumericMenu.js

@@ -129,6 +129,7 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(_ref7) {
+        var _this = this;
         var results = _ref7.results,
           state = _ref7.state,
           instantSearchInstance = _ref7.instantSearchInstance,
@@ -144,7 +145,12 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         if (!connectorState.createURL) {
           connectorState.createURL = function (newState) {
             return function (facetValue) {
-              return createURL(getRefinedState(newState, attribute, facetValue));
+              return createURL(function (uiState) {
+                return _this.getWidgetUiState(uiState, {
+                  searchParameters: getRefinedState(newState, attribute, facetValue),
+                  helper: helper
+                });
+              });
             };
           };
         }

package/es/connectors/pagination/connectPagination.js

@@ -81,10 +81,12 @@ var connectPagination = function connectPagination(renderFn) {
           };
         }
         if (!connectorState.createURL) {
-          connectorState.createURL = function (helperState) {
-            return function (page) {
-              return createURL(helperState.setPage(page));
-            };
+          connectorState.createURL = function (page) {
+            return createURL(function (uiState) {
+              return _objectSpread(_objectSpread({}, uiState), {}, {
+                page: page
+              });
+            });
           };
         }
         var page = state.page || 0;
@@ -94,7 +96,7 @@ var connectPagination = function connectPagination(renderFn) {
         pager.currentPage = page;
         pager.total = nbPages;
         return {
-          createURL: connectorState.createURL(state),
+          createURL: connectorState.createURL,
           refine: connectorState.refine,
           canRefine: nbPages > 1,
           currentRefinement: page,

package/es/connectors/rating-menu/connectRatingMenu.js

@@ -136,9 +136,16 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
       },
       createURLFactory: function createURLFactory(_ref4) {
         var state = _ref4.state,
-          createURL = _ref4.createURL;
+          createURL = _ref4.createURL,
+          getWidgetUiState = _ref4.getWidgetUiState,
+          helper = _ref4.helper;
         return function (value) {
-          return createURL(getRefinedState(state, value));
+          return createURL(function (uiState) {
+            return getWidgetUiState(uiState, {
+              searchParameters: getRefinedState(state, value),
+              helper: helper
+            });
+          });
         };
       }
     };
@@ -234,7 +241,9 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
           sendEvent: sendEvent,
           createURL: connectorState.createURLFactory({
             state: state,
-            createURL: createURL
+            createURL: createURL,
+            helper: helper,
+            getWidgetUiState: this.getWidgetUiState
           }),
           widgetParams: widgetParams
         };

package/es/connectors/refinement-list/connectRefinementList.js

@@ -157,6 +157,7 @@ var connectRefinementList = function connectRefinementList(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(renderOptions) {
+        var _this = this;
         var results = renderOptions.results,
           state = renderOptions.state,
           _createURL = renderOptions.createURL,
@@ -210,7 +211,12 @@ var connectRefinementList = function connectRefinementList(renderFn) {
         var canToggleShowMore = canShowLess || canShowMore;
         return {
           createURL: function createURL(facetValue) {
-            return _createURL(state.resetPage().toggleFacetRefinement(attribute, facetValue));
+            return _createURL(function (uiState) {
+              return _this.getWidgetUiState(uiState, {
+                searchParameters: state.resetPage().toggleFacetRefinement(attribute, facetValue),
+                helper: helper
+              });
+            });
           },
           items: items,
           refine: triggerRefine,

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

@@ -55,7 +55,7 @@ export type ToggleRefinementRenderState = {
     /**
      * Creates an URL for the next state.
      */
-    createURL: CreateURL<string>;
+    createURL: CreateURL<void>;
     /**
      * Send a "Facet Clicked" Insights event.
      */

package/es/connectors/toggle-refinement/connectToggleRefinement.js

@@ -119,7 +119,9 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
     var connectorState = {
       createURLFactory: function createURLFactory(isRefined, _ref4) {
         var state = _ref4.state,
-          createURL = _ref4.createURL;
+          createURL = _ref4.createURL,
+          getWidgetUiState = _ref4.getWidgetUiState,
+          helper = _ref4.helper;
         return function () {
           state = state.resetPage();
           var valuesToRemove = isRefined ? on : off;
@@ -134,7 +136,12 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
               state = state.addDisjunctiveFacetRefinement(attribute, v);
             });
           }
-          return createURL(state);
+          return createURL(function (uiState) {
+            return getWidgetUiState(uiState, {
+              searchParameters: state,
+              helper: helper
+            });
+          });
         };
       }
     };
@@ -239,7 +246,9 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           },
           createURL: connectorState.createURLFactory(isRefined, {
             state: state,
-            createURL: createURL
+            createURL: createURL,
+            helper: helper,
+            getWidgetUiState: this.getWidgetUiState
           }),
           sendEvent: sendEvent,
           canRefine: Boolean(results ? nextRefinement.count : null),
@@ -253,6 +262,9 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           return searchParameters.isDisjunctiveFacetRefined(attribute, v);
         });
         if (!isRefined) {
+          var _uiState$toggle;
+          // This needs to be done in the case `uiState` comes from `createURL`
+          (_uiState$toggle = uiState.toggle) === null || _uiState$toggle === void 0 ? true : delete _uiState$toggle[attribute];
           return uiState;
         }
         return _objectSpread(_objectSpread({}, uiState), {}, {

package/es/lib/utils/render-args.d.ts

@@ -8,7 +8,117 @@ export declare function createInitArgs(instantSearchInstance: InstantSearch, par
     state: import("algoliasearch-helper").SearchParameters;
     renderState: import("../../types").RenderState;
     templatesConfig: Record<string, unknown>;
-    createURL: (state: import("algoliasearch-helper").SearchParameters) => string;
+    createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
+        query: string;
+    } & {
+        configure: import("algoliasearch-helper").PlainSearchParameters;
+    } & {
+        geoSearch: {
+            boundingBox: string;
+        };
+    } & {
+        hierarchicalMenu: {
+            [rootAttribute: string]: string[];
+        };
+    } & {
+        hitsPerPage: number;
+    } & {
+        page: number;
+    } & {
+        menu: {
+            [attribute: string]: string;
+        };
+    } & {
+        numericMenu: {
+            [attribute: string]: string;
+        };
+    } & {
+        page: number;
+    } & {
+        range: {
+            [attribute: string]: string;
+        };
+    } & {
+        ratingMenu: {
+            [attribute: string]: number;
+        };
+    } & {
+        refinementList: {
+            [attribute: string]: string[];
+        };
+    } & {
+        relevantSort: number;
+    } & {
+        query: string;
+    } & {
+        sortBy: string;
+    } & {
+        toggle: {
+            [attribute: string]: boolean;
+        };
+    } & {
+        query: string;
+    } & {
+        places: {
+            query: string;
+            position: string;
+        };
+    }>) => Partial<{
+        query: string;
+    } & {
+        configure: import("algoliasearch-helper").PlainSearchParameters;
+    } & {
+        geoSearch: {
+            boundingBox: string;
+        };
+    } & {
+        hierarchicalMenu: {
+            [rootAttribute: string]: string[];
+        };
+    } & {
+        hitsPerPage: number;
+    } & {
+        page: number;
+    } & {
+        menu: {
+            [attribute: string]: string;
+        };
+    } & {
+        numericMenu: {
+            [attribute: string]: string;
+        };
+    } & {
+        page: number;
+    } & {
+        range: {
+            [attribute: string]: string;
+        };
+    } & {
+        ratingMenu: {
+            [attribute: string]: number;
+        };
+    } & {
+        refinementList: {
+            [attribute: string]: string[];
+        };
+    } & {
+        relevantSort: number;
+    } & {
+        query: string;
+    } & {
+        sortBy: string;
+    } & {
+        toggle: {
+            [attribute: string]: boolean;
+        };
+    } & {
+        query: string;
+    } & {
+        places: {
+            query: string;
+            position: string;
+        };
+    }>)) => string;
     scopedResults: never[];
     searchMetadata: {
         isSearchStalled: boolean;
@@ -25,7 +135,117 @@ export declare function createRenderArgs(instantSearchInstance: InstantSearch, p
     state: import("algoliasearch-helper").SearchParameters;
     renderState: import("../../types").RenderState;
     templatesConfig: Record<string, unknown>;
-    createURL: (state: import("algoliasearch-helper").SearchParameters) => string;
+    createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
+        query: string;
+    } & {
+        configure: import("algoliasearch-helper").PlainSearchParameters;
+    } & {
+        geoSearch: {
+            boundingBox: string;
+        };
+    } & {
+        hierarchicalMenu: {
+            [rootAttribute: string]: string[];
+        };
+    } & {
+        hitsPerPage: number;
+    } & {
+        page: number;
+    } & {
+        menu: {
+            [attribute: string]: string;
+        };
+    } & {
+        numericMenu: {
+            [attribute: string]: string;
+        };
+    } & {
+        page: number;
+    } & {
+        range: {
+            [attribute: string]: string;
+        };
+    } & {
+        ratingMenu: {
+            [attribute: string]: number;
+        };
+    } & {
+        refinementList: {
+            [attribute: string]: string[];
+        };
+    } & {
+        relevantSort: number;
+    } & {
+        query: string;
+    } & {
+        sortBy: string;
+    } & {
+        toggle: {
+            [attribute: string]: boolean;
+        };
+    } & {
+        query: string;
+    } & {
+        places: {
+            query: string;
+            position: string;
+        };
+    }>) => Partial<{
+        query: string;
+    } & {
+        configure: import("algoliasearch-helper").PlainSearchParameters;
+    } & {
+        geoSearch: {
+            boundingBox: string;
+        };
+    } & {
+        hierarchicalMenu: {
+            [rootAttribute: string]: string[];
+        };
+    } & {
+        hitsPerPage: number;
+    } & {
+        page: number;
+    } & {
+        menu: {
+            [attribute: string]: string;
+        };
+    } & {
+        numericMenu: {
+            [attribute: string]: string;
+        };
+    } & {
+        page: number;
+    } & {
+        range: {
+            [attribute: string]: string;
+        };
+    } & {
+        ratingMenu: {
+            [attribute: string]: number;
+        };
+    } & {
+        refinementList: {
+            [attribute: string]: string[];
+        };
+    } & {
+        relevantSort: number;
+    } & {
+        query: string;
+    } & {
+        sortBy: string;
+    } & {
+        toggle: {
+            [attribute: string]: boolean;
+        };
+    } & {
+        query: string;
+    } & {
+        places: {
+            query: string;
+            position: string;
+        };
+    }>)) => string;
     searchMetadata: {
         isSearchStalled: boolean;
     };

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.56.4";
+declare const _default: "4.56.5";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.56.4';
+export default '4.56.5';

package/es/middlewares/createRouterMiddleware.js

@@ -18,9 +18,17 @@ export var createRouterMiddleware = function createRouterMiddleware() {
   return function (_ref) {
     var instantSearchInstance = _ref.instantSearchInstance;
     function topLevelCreateURL(nextState) {
+      var previousUiState =
+      // If only the mainIndex is initialized, we don't yet know what other
+      // index widgets are used. Therefore we fall back to the initialUiState.
+      // We can't indiscriminately use the initialUiState because then we
+      // reintroduce state that was changed by the user.
+      // When there are no widgets, we are sure the user can't yet have made
+      // any changes.
+      instantSearchInstance.mainIndex.getWidgets().length === 0 ? instantSearchInstance._initialUiState : instantSearchInstance.mainIndex.getWidgetUiState({});
       var uiState = Object.keys(nextState).reduce(function (acc, indexId) {
         return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, indexId, nextState[indexId]));
-      }, instantSearchInstance.mainIndex.getWidgetUiState({}));
+      }, previousUiState);
       var route = stateMapping.stateToRoute(uiState);
       return router.createURL(route);
     }

package/es/types/widget.d.ts

@@ -24,7 +24,7 @@ type SharedRenderOptions = {
     };
     status: InstantSearch['status'];
     error: InstantSearch['error'];
-    createURL: (state: SearchParameters) => string;
+    createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
 };
 export type InitOptions = SharedRenderOptions & {
     uiState: UiState;

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

@@ -27,7 +27,7 @@ export type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexW
     getScopedResults: () => ScopedResult[];
     getParent: () => IndexWidget | null;
     getWidgets: () => Array<Widget | IndexWidget>;
-    createURL: (state: SearchParameters) => string;
+    createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     addWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
     removeWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
     init: (options: IndexInitOptions) => void;

package/es/widgets/index/index.js

@@ -140,6 +140,9 @@ var index = function index(widgetParams) {
       return localParent;
     },
     createURL: function createURL(nextState) {
+      if (typeof nextState === 'function') {
+        return localInstantSearchInstance._createURL(_defineProperty({}, indexId, nextState(localUiState)));
+      }
       return localInstantSearchInstance._createURL(_defineProperty({}, indexId, getLocalWidgetsUiState(localWidgets, {
         searchParameters: nextState,
         helper: helper
@@ -204,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 _nextState = widgets.reduce(function (state, widget) {
           // the `dispose` method exists at this point we already assert it
           var next = widget.dispose({
             helper: helper,
@@ -214,12 +217,12 @@ var index = function index(widgetParams) {
           return next || state;
         }, helper.state);
         localUiState = getLocalWidgetsUiState(localWidgets, {
-          searchParameters: nextState,
+          searchParameters: _nextState,
           helper: helper
         });
         helper.setState(getLocalWidgetsSearchParameters(localWidgets, {
           uiState: localUiState,
-          initialSearchParameters: nextState
+          initialSearchParameters: _nextState
         }));
         if (localWidgets.length) {
           localInstantSearchInstance.scheduleSearch();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.56.4",
+  "version": "4.56.5",
   "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",
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.17.0",
-    "@instantsearch/tests": "1.17.0",
-    "@instantsearch/testutils": "1.6.0",
+    "@instantsearch/mocks": "1.18.0",
+    "@instantsearch/tests": "1.18.0",
+    "@instantsearch/testutils": "1.7.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": "d441895874038286168b028c1a45193b1fce8eaf"
+  "gitHead": "99119060ec345379181f0446ea4ca8d7cf331354"
 }