instantsearch.js 4.51.1 → 4.53.0

package/es/widgets/breadcrumb/breadcrumb.js

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import Breadcrumb from "../../components/Breadcrumb/Breadcrumb.js";
 import connectBreadcrumb from "../../connectors/breadcrumb/connectBreadcrumb.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'breadcrumb'
 });

package/es/widgets/clear-refinements/clear-refinements.js

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
+import { cx } from '@algolia/ui-components-shared';
 import { h, render } from 'preact';
 import ClearRefinements from "../../components/ClearRefinements/ClearRefinements.js";
-import { cx } from '@algolia/ui-components-shared';
 import connectClearRefinements from "../../connectors/clear-refinements/connectClearRefinements.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'clear-refinements'
 });

package/es/widgets/configure/configure.js

@@ -6,12 +6,6 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 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); }
 import connectConfigure from "../../connectors/configure/connectConfigure.js";
 import { noop } from "../../lib/utils/index.js";
-
-/**
- * A list of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/)
- * to enable when the widget mounts.
- */
-
 var configure = function configure(widgetParams) {
   // This is a renderless widget that falls back to the connector's
   // noop render and unmount functions.

package/es/widgets/configure-related-items/configure-related-items.d.ts

@@ -1,6 +1,6 @@
-import type { PlainSearchParameters } from 'algoliasearch-helper';
 import type { ConfigureRelatedItemsConnectorParams, ConfigureRelatedItemsWidgetDescription } from '../../connectors/configure-related-items/connectConfigureRelatedItems';
 import type { WidgetFactory } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 export type ConfigureRelatedItemsWidget = WidgetFactory<ConfigureRelatedItemsWidgetDescription & {
     $$widgetType: 'ais.configureRelatedItems';
 }, ConfigureRelatedItemsConnectorParams, ConfigureRelatedItemsWidgetParams>;

package/es/widgets/configure-related-items/configure-related-items.js

@@ -4,8 +4,8 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { noop } from "../../lib/utils/index.js";
 import connectConfigureRelatedItems from "../../connectors/configure-related-items/connectConfigureRelatedItems.js";
+import { noop } from "../../lib/utils/index.js";
 var configureRelatedItems = function configureRelatedItems(widgetParams) {
   var makeWidget = connectConfigureRelatedItems(noop);
   return _objectSpread(_objectSpread({}, makeWidget(widgetParams)), {}, {

package/es/widgets/current-refinements/current-refinements.js

@@ -4,12 +4,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import CurrentRefinements from "../../components/CurrentRefinements/CurrentRefinements.js";
 import connectCurrentRefinements from "../../connectors/current-refinements/connectCurrentRefinements.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 import { component } from "../../lib/suit.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'current-refinements'
 });

package/es/widgets/geo-search/GeoSearchRenderer.js

@@ -11,8 +11,8 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
 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; }
 import { h, render } from 'preact';
-import { prepareTemplateProps } from "../../lib/templating/index.js";
 import GeoSearchControls from "../../components/GeoSearchControls/GeoSearchControls.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
 var refineWithMap = function refineWithMap(_ref) {
   var refine = _ref.refine,
     mapInstance = _ref.mapInstance;

package/es/widgets/geo-search/geo-search.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="google.maps" />
 /// <reference types="googlemaps" />
 import type { GeoSearchConnectorParams, GeoSearchWidgetDescription, GeoHit } from '../../connectors/geo-search/connectGeoSearch';
-import type { HTMLMarkerArguments } from './createHTMLMarker';
 import type { GeoLoc, Template, WidgetFactory } from '../../types';
+import type { HTMLMarkerArguments } from './createHTMLMarker';
 export type CreateMarker = (args: {
     item: GeoHit;
     map: google.maps.Map;

package/es/widgets/geo-search/geo-search.js

@@ -13,13 +13,13 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
 /* global google */
 import { cx } from '@algolia/ui-components-shared';
 import { render } from 'preact';
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { renderTemplate } from "../../lib/templating/index.js";
-import { component } from "../../lib/suit.js";
 import connectGeoSearch from "../../connectors/geo-search/connectGeoSearch.js";
-import renderer from "./GeoSearchRenderer.js";
-import defaultTemplates from "./defaultTemplates.js";
+import { component } from "../../lib/suit.js";
+import { renderTemplate } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 import createHTMLMarker from "./createHTMLMarker.js";
+import defaultTemplates from "./defaultTemplates.js";
+import renderer from "./GeoSearchRenderer.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'geo-search'
 });

package/es/widgets/hierarchical-menu/defaultTemplates.js

@@ -1,6 +1,6 @@
+import { cx } from '@algolia/ui-components-shared';
 import { h } from 'preact';
 import { formatNumber } from "../../lib/formatNumber.js";
-import { cx } from '@algolia/ui-components-shared';
 var defaultTemplates = {
   item: function item(_ref) {
     var url = _ref.url,

package/es/widgets/hierarchical-menu/hierarchical-menu.js

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import RefinementList from "../../components/RefinementList/RefinementList.js";
 import connectHierarchicalMenu from "../../connectors/hierarchical-menu/connectHierarchicalMenu.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'hierarchical-menu'
 });

package/es/widgets/hits/defaultTemplates.js

@@ -1,9 +1,10 @@
+import { omit } from "../../lib/utils/index.js";
 var defaultTemplates = {
   empty: function empty() {
     return 'No results';
   },
   item: function item(data) {
-    return JSON.stringify(data, null, 2);
+    return JSON.stringify(omit(data, ['__hitIndex']), null, 2);
   }
 };
 export default defaultTemplates;

package/es/widgets/hits/hits.d.ts

@@ -33,6 +33,7 @@ export type HitsTemplates = Partial<{
      * @default ''
      */
     item: TemplateWithBindEvent<Hit & {
+        /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
 }>;

package/es/widgets/hits/hits.js

@@ -4,15 +4,15 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
-import connectHits from "../../connectors/hits/connectHits.js";
+import { h, render } from 'preact';
 import Hits from "../../components/Hits/Hits.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
-import { component } from "../../lib/suit.js";
+import connectHits from "../../connectors/hits/connectHits.js";
 import { withInsights, withInsightsListener } from "../../lib/insights/index.js";
+import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'hits'
 });

package/es/widgets/hits-per-page/hits-per-page.js

@@ -4,12 +4,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import Selector from "../../components/Selector/Selector.js";
 import connectHitsPerPage from "../../connectors/hits-per-page/connectHitsPerPage.js";
-import { getContainerNode, createDocumentationMessageGenerator, find } from "../../lib/utils/index.js";
 import { component } from "../../lib/suit.js";
+import { getContainerNode, createDocumentationMessageGenerator, find } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'hits-per-page'
 });

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

@@ -1,5 +1,5 @@
-import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 import type { InstantSearch, UiState, IndexUiState, Widget, ScopedResult } from '../../types';
+import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 export type IndexWidgetParams = {
     indexName: string;
     indexId?: string;
@@ -16,7 +16,7 @@ export type IndexWidgetDescription = {
     $$type: 'ais.index';
     $$widgetType: 'ais.index';
 };
-export type IndexWidget = Omit<Widget<IndexWidgetDescription & {
+export type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexWidgetDescription & {
     widgetParams: IndexWidgetParams;
 }>, 'getWidgetUiState' | 'getWidgetState'> & {
     getIndexName(): string;
@@ -37,11 +37,21 @@ export type IndexWidget = Omit<Widget<IndexWidgetDescription & {
      * @deprecated
      */
     getWidgetState(uiState: UiState): UiState;
-    getWidgetUiState<TUiState extends UiState = UiState>(uiState: TUiState): TUiState;
+    getWidgetUiState<TSpecificUiState extends UiState = TUiState>(uiState: TSpecificUiState): TSpecificUiState;
     getWidgetSearchParameters(searchParameters: SearchParameters, searchParametersOptions: {
         uiState: IndexUiState;
     }): SearchParameters;
+    /**
+     * Set this index' UI state back to the state defined by the widgets.
+     * Can only be called after `init`.
+     */
     refreshUiState(): void;
+    /**
+     * Set this index' UI state and search. This is the equivalent of calling
+     * a spread `setUiState` on the InstantSearch instance.
+     * Can only be called after `init`.
+     */
+    setIndexUiState(indexUiState: TUiState[string] | ((previousIndexUiState: TUiState[string]) => TUiState[string])): void;
 };
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 export default index;

package/es/widgets/index/index.js

@@ -421,7 +421,9 @@ var index = function index(widgetParams) {
       });
     },
     dispose: function dispose() {
-      var _this5 = this;
+      var _this5 = this,
+        _helper,
+        _derivedHelper2;
       localWidgets.forEach(function (widget) {
         if (widget.dispose) {
           // The dispose function is always called once the instance is started
@@ -439,9 +441,9 @@ var index = function index(widgetParams) {
       });
       localInstantSearchInstance = null;
       localParent = null;
-      helper.removeAllListeners();
+      (_helper = helper) === null || _helper === void 0 ? void 0 : _helper.removeAllListeners();
       helper = null;
-      derivedHelper.detach();
+      (_derivedHelper2 = derivedHelper) === null || _derivedHelper2 === void 0 ? void 0 : _derivedHelper2.detach();
       derivedHelper = null;
     },
     getWidgetUiState: function getWidgetUiState(uiState) {
@@ -465,6 +467,12 @@ var index = function index(widgetParams) {
         searchParameters: this.getHelper().state,
         helper: this.getHelper()
       }, localUiState);
+    },
+    setIndexUiState: function setIndexUiState(indexUiState) {
+      var nextIndexUiState = typeof indexUiState === 'function' ? indexUiState(localUiState) : indexUiState;
+      localInstantSearchInstance.setUiState(function (state) {
+        return _objectSpread(_objectSpread({}, state), {}, _defineProperty({}, indexId, nextIndexUiState));
+      });
     }
   };
 };

package/es/widgets/index.d.ts

@@ -1,15 +1,15 @@
+import dynamicWidgets from './dynamic-widgets/dynamic-widgets';
+/** @deprecated answers is no longer supported */
+export declare const EXPERIMENTAL_answers: import("./answers/answers").AnswersWidget;
+/** @deprecated use dynamicWidgets */
+export declare const EXPERIMENTAL_dynamicWidgets: import("./dynamic-widgets/dynamic-widgets").DynamicWidgetsWidget;
+export { dynamicWidgets };
 export { default as analytics } from './analytics/analytics';
 export { default as breadcrumb } from './breadcrumb/breadcrumb';
 export { default as clearRefinements } from './clear-refinements/clear-refinements';
 export { default as configure } from './configure/configure';
 export { default as currentRefinements } from './current-refinements/current-refinements';
-/** @deprecated answers is no longer supported */
-export declare const EXPERIMENTAL_answers: import("./answers/answers").AnswersWidget;
 export { default as EXPERIMENTAL_configureRelatedItems } from './configure-related-items/configure-related-items';
-import dynamicWidgets from './dynamic-widgets/dynamic-widgets';
-export { dynamicWidgets };
-/** @deprecated use dynamicWidgets */
-export declare const EXPERIMENTAL_dynamicWidgets: import("./dynamic-widgets/dynamic-widgets").DynamicWidgetsWidget;
 export { default as geoSearch } from './geo-search/geo-search';
 export { default as hierarchicalMenu } from './hierarchical-menu/hierarchical-menu';
 export { default as hits } from './hits/hits';

package/es/widgets/index.js

@@ -1,17 +1,19 @@
 import { deprecate } from "../lib/utils/index.js";
+import answers from "./answers/answers.js";
+import dynamicWidgets from "./dynamic-widgets/dynamic-widgets.js";
+
+/** @deprecated answers is no longer supported */
+export var EXPERIMENTAL_answers = deprecate(answers, 'answers is no longer supported');
+
+/** @deprecated use dynamicWidgets */
+export var EXPERIMENTAL_dynamicWidgets = deprecate(dynamicWidgets, 'use dynamicWidgets');
+export { dynamicWidgets };
 export { default as analytics } from "./analytics/analytics.js";
 export { default as breadcrumb } from "./breadcrumb/breadcrumb.js";
 export { default as clearRefinements } from "./clear-refinements/clear-refinements.js";
 export { default as configure } from "./configure/configure.js";
 export { default as currentRefinements } from "./current-refinements/current-refinements.js";
-import answers from "./answers/answers.js";
-/** @deprecated answers is no longer supported */
-export var EXPERIMENTAL_answers = deprecate(answers, 'answers is no longer supported');
 export { default as EXPERIMENTAL_configureRelatedItems } from "./configure-related-items/configure-related-items.js";
-import dynamicWidgets from "./dynamic-widgets/dynamic-widgets.js";
-export { dynamicWidgets };
-/** @deprecated use dynamicWidgets */
-export var EXPERIMENTAL_dynamicWidgets = deprecate(dynamicWidgets, 'use dynamicWidgets');
 export { default as geoSearch } from "./geo-search/geo-search.js";
 export { default as hierarchicalMenu } from "./hierarchical-menu/hierarchical-menu.js";
 export { default as hits } from "./hits/hits.js";

package/es/widgets/infinite-hits/defaultTemplates.js

@@ -1,3 +1,4 @@
+import { omit } from "../../lib/utils/index.js";
 var defaultTemplates = {
   empty: function empty() {
     return 'No results';
@@ -9,7 +10,7 @@ var defaultTemplates = {
     return 'Show more results';
   },
   item: function item(data) {
-    return JSON.stringify(data, null, 2);
+    return JSON.stringify(omit(data, ['__hitIndex']), null, 2);
   }
 };
 export default defaultTemplates;

package/es/widgets/infinite-hits/infinite-hits.d.ts

@@ -1,7 +1,7 @@
 
-import type { SearchResults } from 'algoliasearch-helper';
 import type { InfiniteHitsConnectorParams, InfiniteHitsCache, InfiniteHitsWidgetDescription } from '../../connectors/infinite-hits/connectInfiniteHits';
 import type { WidgetFactory, Template, TemplateWithBindEvent, Hit } from '../../types';
+import type { SearchResults } from 'algoliasearch-helper';
 export type InfiniteHitsCSSClasses = Partial<{
     /**
      * The root element of the widget.
@@ -53,6 +53,7 @@ export type InfiniteHitsTemplates = Partial<{
      * The template to use for each result.
      */
     item: TemplateWithBindEvent<Hit & {
+        /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
 }>;

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

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import InfiniteHits from "../../components/InfiniteHits/InfiniteHits.js";
 import connectInfiniteHits from "../../connectors/infinite-hits/connectInfiniteHits.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
-import { component } from "../../lib/suit.js";
 import { withInsights, withInsightsListener } from "../../lib/insights/index.js";
+import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'infinite-hits'

package/es/widgets/menu/defaultTemplates.js

@@ -1,6 +1,6 @@
+import { cx } from '@algolia/ui-components-shared';
 import { h } from 'preact';
 import { formatNumber } from "../../lib/formatNumber.js";
-import { cx } from '@algolia/ui-components-shared';
 var defaultTemplates = {
   item: function item(_ref) {
     var cssClasses = _ref.cssClasses,

package/es/widgets/menu/menu.js

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import RefinementList from "../../components/RefinementList/RefinementList.js";
 import connectMenu from "../../connectors/menu/connectMenu.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'menu'
 });

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

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
-import connectMenu from "../../connectors/menu/connectMenu.js";
+import { h, render } from 'preact';
 import MenuSelect from "../../components/MenuSelect/MenuSelect.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
+import connectMenu from "../../connectors/menu/connectMenu.js";
 import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'menu-select'
 });

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

@@ -4,14 +4,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import RefinementList from "../../components/RefinementList/RefinementList.js";
 import connectNumericMenu from "../../connectors/numeric-menu/connectNumericMenu.js";
-import defaultTemplates from "./defaultTemplates.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 import { component } from "../../lib/suit.js";
 import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'numeric-menu'
 });

package/es/widgets/pagination/pagination.js

@@ -4,12 +4,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import Pagination from "../../components/Pagination/Pagination.js";
 import connectPagination from "../../connectors/pagination/connectPagination.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 import { component } from "../../lib/suit.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 var suit = component('Pagination');
 var withUsage = createDocumentationMessageGenerator({
   name: 'pagination'

package/es/widgets/panel/panel.js

@@ -4,11 +4,11 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
-import { createDocumentationMessageGenerator, getContainerNode, getObjectType, warning } from "../../lib/utils/index.js";
-import { component } from "../../lib/suit.js";
+import { h, render } from 'preact';
 import Panel from "../../components/Panel/Panel.js";
+import { component } from "../../lib/suit.js";
+import { createDocumentationMessageGenerator, getContainerNode, getObjectType, warning } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'panel'
 });
@@ -94,7 +94,7 @@ var panel = function panel(panelWidgetParams) {
         footer: '',
         collapseButtonText: function collapseButtonText(_ref4) {
           var isCollapsed = _ref4.collapsed;
-          return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          width=\"1em\"\n          height=\"1em\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");
+          return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          style=\"width: 1em; height: 1em;\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");
         }
       };
       var renderPanel = renderer({

package/es/widgets/places/places.d.ts

@@ -1,6 +1,6 @@
 // @ts-ignore
-import type * as Places from 'places.js';
 import type { WidgetFactory, WidgetRenderState } from '../../types';
+import type * as Places from 'places.js';
 type StaticOptions = Places.StaticOptions;
 type PlacesInstance = Places.PlacesInstance;
 type ReconfigurableOptions = Places.ReconfigurableOptions;

package/es/widgets/powered-by/powered-by.js

@@ -4,12 +4,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
+import { h, render } from 'preact';
 import PoweredBy from "../../components/PoweredBy/PoweredBy.js";
 import connectPoweredBy from "../../connectors/powered-by/connectPoweredBy.js";
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 import { component } from "../../lib/suit.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 var suit = component('PoweredBy');
 var withUsage = createDocumentationMessageGenerator({
   name: 'powered-by'

package/es/widgets/query-rule-context/query-rule-context.d.ts

@@ -1,5 +1,5 @@
-import type { WidgetFactory } from '../../types';
 import type { ParamTrackedFilters, ParamTransformRuleContexts, QueryRulesConnectorParams, QueryRulesWidgetDescription } from '../../connectors/query-rules/connectQueryRules';
+import type { WidgetFactory } from '../../types';
 export type QueryRuleContextWidgetParams = {
     trackedFilters: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;

package/es/widgets/query-rule-context/query-rule-context.js

@@ -4,8 +4,8 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { createDocumentationMessageGenerator, noop } from "../../lib/utils/index.js";
 import connectQueryRules from "../../connectors/query-rules/connectQueryRules.js";
+import { createDocumentationMessageGenerator, noop } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'query-rule-context'
 });

package/es/widgets/query-rule-custom-data/query-rule-custom-data.d.ts

@@ -1,7 +1,7 @@
 
-import type { WidgetFactory, Template } from '../../types';
-import type { QueryRulesConnectorParams, QueryRulesWidgetDescription } from '../../connectors/query-rules/connectQueryRules';
 import type { QueryRuleCustomDataComponentTemplates } from '../../components/QueryRuleCustomData/QueryRuleCustomData';
+import type { QueryRulesConnectorParams, QueryRulesWidgetDescription } from '../../connectors/query-rules/connectQueryRules';
+import type { WidgetFactory, Template } from '../../types';
 export type QueryRuleCustomDataCSSClasses = Partial<{
     root: string | string[];
 }>;

package/es/widgets/query-rule-custom-data/query-rule-custom-data.js

@@ -4,12 +4,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-import { h, render } from 'preact';
 import { cx } from '@algolia/ui-components-shared';
-import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
-import { component } from "../../lib/suit.js";
-import connectQueryRules from "../../connectors/query-rules/connectQueryRules.js";
+import { h, render } from 'preact';
 import CustomData from "../../components/QueryRuleCustomData/QueryRuleCustomData.js";
+import connectQueryRules from "../../connectors/query-rules/connectQueryRules.js";
+import { component } from "../../lib/suit.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
 export var defaultTemplates = {
   default: function _default(_ref) {
     var items = _ref.items;