instantsearch.js 4.46.0 → 4.46.2

package/cjs/widgets/index/index.js

@@ -3,7 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isIndexWidget = isIndexWidget;
 exports.default = void 0;
 
 var _algoliasearchHelper = _interopRequireDefault(require("algoliasearch-helper"));
@@ -38,16 +37,11 @@ var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'index-widget'
 });
 
-function isIndexWidget(widget) {
-  return widget.$$type === 'ais.index';
-}
 /**
  * This is the same content as helper._change / setState, but allowing for extra
  * UiState to be synchronized.
  * see: https://github.com/algolia/algoliasearch-helper-js/blob/6b835ffd07742f2d6b314022cce6848f5cfecd4a/src/algoliasearch.helper.js#L1311-L1324
  */
-
-
 function privateHelperSetState(helper, _ref) {
   var state = _ref.state,
       isPageReset = _ref.isPageReset,
@@ -67,7 +61,7 @@ function privateHelperSetState(helper, _ref) {
 function getLocalWidgetsUiState(widgets, widgetStateOptions) {
   var initialUiState = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return widgets.reduce(function (uiState, widget) {
-    if (isIndexWidget(widget)) {
+    if ((0, _index.isIndexWidget)(widget)) {
       return uiState;
     }
 
@@ -88,7 +82,7 @@ function getLocalWidgetsSearchParameters(widgets, widgetSearchParametersOptions)
       rest = _objectWithoutProperties(widgetSearchParametersOptions, ["initialSearchParameters"]);
 
   return widgets.filter(function (widget) {
-    return !isIndexWidget(widget);
+    return !(0, _index.isIndexWidget)(widget);
   }).reduce(function (state, widget) {
     if (!widget.getWidgetSearchParameters) {
       return state;
@@ -99,7 +93,7 @@ function getLocalWidgetsSearchParameters(widgets, widgetSearchParametersOptions)
 }
 
 function resetPageFromWidgets(widgets) {
-  var indexWidgets = widgets.filter(isIndexWidget);
+  var indexWidgets = widgets.filter(_index.isIndexWidget);
 
   if (indexWidgets.length === 0) {
     return;
@@ -116,7 +110,7 @@ function resetPageFromWidgets(widgets) {
 }
 
 function resolveScopedResultsFromWidgets(widgets) {
-  var indexWidgets = widgets.filter(isIndexWidget);
+  var indexWidgets = widgets.filter(_index.isIndexWidget);
   return indexWidgets.reduce(function (scopedResults, current) {
     return scopedResults.concat.apply(scopedResults, [{
       indexId: current.getIndexId(),
@@ -326,7 +320,9 @@ var index = function index(widgetParams) {
         if (instantSearchInstance.onStateChange) {
           instantSearchInstance.onStateChange({
             uiState: instantSearchInstance.mainIndex.getWidgetUiState({}),
-            setUiState: instantSearchInstance.setUiState.bind(instantSearchInstance)
+            setUiState: function setUiState(nextState) {
+              return instantSearchInstance.setUiState(nextState, false);
+            }
           }); // We don't trigger a search when controlled because it becomes the
           // responsibility of `setUiState`.
 
@@ -554,7 +550,7 @@ var index = function index(widgetParams) {
       derivedHelper = null;
     },
     getWidgetUiState: function getWidgetUiState(uiState) {
-      return localWidgets.filter(isIndexWidget).reduce(function (previousUiState, innerIndex) {
+      return localWidgets.filter(_index.isIndexWidget).reduce(function (previousUiState, innerIndex) {
         return innerIndex.getWidgetUiState(previousUiState);
       }, _objectSpread(_objectSpread({}, uiState), {}, _defineProperty({}, this.getIndexId(), localUiState)));
     },

package/cjs/widgets/infinite-hits/infinite-hits.js

@@ -15,9 +15,11 @@ var _connectInfiniteHits = _interopRequireDefault(require("../../connectors/infi
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
-var _index2 = require("../../lib/insights/index.js");
+var _index3 = require("../../lib/insights/index.js");
 
 var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"));
 
@@ -33,7 +35,7 @@ var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'infinite-hits'
 });
 var suit = (0, _suit.component)('InfiniteHits');
-var InfiniteHitsWithInsightsListener = (0, _index2.withInsightsListener)(_InfiniteHits.default);
+var InfiniteHitsWithInsightsListener = (0, _index3.withInsightsListener)(_InfiniteHits.default);
 
 var renderer = function renderer(_ref) {
   var containerNode = _ref.containerNode,
@@ -53,7 +55,7 @@ var renderer = function renderer(_ref) {
         bindEvent = _ref2.bindEvent;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates
@@ -130,7 +132,7 @@ var infiniteHits = function infiniteHits(widgetParams) {
     showPrevious: showPrevious,
     renderState: {}
   });
-  var makeWidget = (0, _index2.withInsights)(_connectInfiniteHits.default)(specializedRenderer, function () {
+  var makeWidget = (0, _index3.withInsights)(_connectInfiniteHits.default)(specializedRenderer, function () {
     return (0, _preact.render)(null, containerNode);
   });
   return _objectSpread(_objectSpread({}, makeWidget({

package/cjs/widgets/menu/defaultTemplates.js

@@ -11,7 +11,6 @@ var _formatNumber = require("../../lib/formatNumber.js");
 
 var _index = require("../../lib/utils/index.js");
 
-/** @jsx h */
 var defaultTemplates = {
   item: function item(_ref) {
     var cssClasses = _ref.cssClasses,

package/cjs/widgets/menu/menu.js

@@ -17,6 +17,8 @@ var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"))
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -48,7 +50,7 @@ var renderer = function renderer(_ref) {
         canToggleShowMore = _ref2.canToggleShowMore;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/menu-select/menu-select.js

@@ -17,6 +17,8 @@ var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"))
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -43,7 +45,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/numeric-menu/defaultTemplates.js

@@ -7,7 +7,6 @@ exports.default = void 0;
 
 var _preact = require("preact");
 
-/** @jsx h */
 var defaultTemplates = {
   item: function item(_ref) {
     var cssClasses = _ref.cssClasses,

package/cjs/widgets/numeric-menu/numeric-menu.js

@@ -19,6 +19,8 @@ var _index = require("../../lib/utils/index.js");
 
 var _suit = require("../../lib/suit.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
@@ -45,7 +47,7 @@ var renderer = function renderer(_ref) {
         items = _ref2.items;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/range-input/range-input.js

@@ -15,6 +15,8 @@ var _connectRange = _interopRequireDefault(require("../../connectors/range/conne
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -63,7 +65,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: defaultTemplates,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/rating-menu/defaultTemplates.js

@@ -11,7 +11,6 @@ var _formatNumber = require("../../lib/formatNumber.js");
 
 var _index = require("../../lib/utils/index.js");
 
-/** @jsx h */
 function ItemWrapper(_ref) {
   var children = _ref.children,
       count = _ref.count,

package/cjs/widgets/rating-menu/rating-menu.js

@@ -17,6 +17,8 @@ var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"))
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -52,7 +54,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/refinement-list/defaultTemplates.js

@@ -11,7 +11,6 @@ var _formatNumber = require("../../lib/formatNumber.js");
 
 var _index = require("../../lib/utils/index.js");
 
-/** @jsx h */
 var defaultTemplates = {
   item: function item(_ref) {
     var cssClasses = _ref.cssClasses,

package/cjs/widgets/refinement-list/refinement-list.js

@@ -15,6 +15,8 @@ var _connectRefinementList = _interopRequireDefault(require("../../connectors/re
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 var _defaultTemplates = _interopRequireDefault(require("../search-box/defaultTemplates.js"));
@@ -58,12 +60,12 @@ var renderer = function renderer(_ref) {
         canToggleShowMore = _ref2.canToggleShowMore;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates2.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates
       });
-      renderState.searchBoxTemplateProps = (0, _index.prepareTemplateProps)({
+      renderState.searchBoxTemplateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: searchBoxTemplates

package/cjs/widgets/search-box/defaultTemplates.js

@@ -7,7 +7,6 @@ exports.default = void 0;
 
 var _preact = require("preact");
 
-/** @jsx h */
 var _ref2 = (0, _preact.h)("path", {
   d: "M8.114 10L.944 2.83 0 1.885 1.886 0l.943.943L10 8.113l7.17-7.17.944-.943L20 1.886l-.943.943-7.17 7.17 7.17 7.17.943.944L18.114 20l-.943-.943-7.17-7.17-7.17 7.17-.944.943L0 18.114l.943-.943L8.113 10z"
 });

package/cjs/widgets/stats/stats.js

@@ -15,6 +15,8 @@ var _connectStats = _interopRequireDefault(require("../../connectors/stats/conne
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 var _formatNumber = require("../../lib/formatNumber.js");
@@ -99,7 +101,7 @@ var renderer = function renderer(_ref3) {
         instantSearchInstance = _ref4.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: defaultTemplates,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/toggle-refinement/toggle-refinement.js

@@ -17,6 +17,8 @@ var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"))
 
 var _index = require("../../lib/utils/index.js");
 
+var _index2 = require("../../lib/templating/index.js");
+
 var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -43,7 +45,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _index.prepareTemplateProps)({
+      renderState.templateProps = (0, _index2.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates

package/cjs/widgets/voice-search/defaultTemplates.js

@@ -7,7 +7,6 @@ exports.default = void 0;
 
 var _preact = require("preact");
 
-/** @jsx h */
 var _ref2 = (0, _preact.h)(_preact.Fragment, null, (0, _preact.h)("line", {
   x1: "1",
   y1: "1",

package/dist/instantsearch.development.d.ts

@@ -1177,6 +1177,8 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
+declare type FacetValue = string | boolean | number;
+
 declare type GeoHit<THit extends BaseHit = Record<string, any>> = Hit<THit> & Required<Pick<Hit, '_geoloc'>>;
 
 declare type GeoLoc = {
@@ -2384,7 +2386,12 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
         cancel(): void;
     };
     scheduleStalledRender(): void;
-    setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
+    /**
+     * Set the UI state and trigger a search.
+     * @param uiState The next UI state or a function computing it from the current state
+     * @param callOnStateChange private parameter used to know if the method is called from a state change
+     */
+    setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState), callOnStateChange?: boolean): void;
     getUiState(): TUiState;
     onInternalStateChange: ((...args: any[]) => void) & {
         wait(): Promise<void>;
@@ -2779,6 +2786,7 @@ declare type MiddlewareDefinition<TUiState extends UiState = UiState> = {
         uiState: TUiState;
     }): void;
     subscribe(): void;
+    started(): void;
     unsubscribe(): void;
 };
 
@@ -5065,11 +5073,11 @@ declare type ToggleRefinementConnectorParams = {
      * Value to filter on when toggled.
      * @default "true"
      */
-    on?: string | string[] | boolean | boolean[] | number | number[];
+    on?: FacetValue | FacetValue[];
     /**
      * Value to filter on when not toggled.
      */
-    off?: string | string[] | boolean | boolean[] | number | number[];
+    off?: FacetValue | FacetValue[];
 };
 
 declare type ToggleRefinementCSSClasses = Partial<{