instantsearch.js 4.51.0 → 4.52.0

package/es/connectors/index.d.ts

@@ -1,3 +1,9 @@
+import connectDynamicWidgets from './dynamic-widgets/connectDynamicWidgets';
+/** @deprecated answers is no longer supported */
+export declare const EXPERIMENTAL_connectAnswers: import("./answers/connectAnswers").AnswersConnector;
+/** @deprecated use connectDynamicWidgets */
+export declare const EXPERIMENTAL_connectDynamicWidgets: import("./dynamic-widgets/connectDynamicWidgets").DynamicWidgetsConnector;
+export { connectDynamicWidgets };
 export { default as connectClearRefinements } from './clear-refinements/connectClearRefinements';
 export { default as connectCurrentRefinements } from './current-refinements/connectCurrentRefinements';
 export { default as connectHierarchicalMenu } from './hierarchical-menu/connectHierarchicalMenu';
@@ -24,10 +30,4 @@ export { default as EXPERIMENTAL_connectConfigureRelatedItems } from './configur
 export { default as connectAutocomplete } from './autocomplete/connectAutocomplete';
 export { default as connectQueryRules } from './query-rules/connectQueryRules';
 export { default as connectVoiceSearch } from './voice-search/connectVoiceSearch';
-/** @deprecated answers is no longer supported */
-export declare const EXPERIMENTAL_connectAnswers: import("./answers/connectAnswers").AnswersConnector;
 export { default as connectRelevantSort } from './relevant-sort/connectRelevantSort';
-import connectDynamicWidgets from './dynamic-widgets/connectDynamicWidgets';
-export { connectDynamicWidgets };
-/** @deprecated use connectDynamicWidgets */
-export declare const EXPERIMENTAL_connectDynamicWidgets: import("./dynamic-widgets/connectDynamicWidgets").DynamicWidgetsConnector;

package/es/connectors/index.js

@@ -1,4 +1,13 @@
 import { deprecate } from "../lib/utils/index.js";
+import connectAnswers from "./answers/connectAnswers.js";
+import connectDynamicWidgets from "./dynamic-widgets/connectDynamicWidgets.js";
+
+/** @deprecated answers is no longer supported */
+export var EXPERIMENTAL_connectAnswers = deprecate(connectAnswers, 'answers is no longer supported');
+
+/** @deprecated use connectDynamicWidgets */
+export var EXPERIMENTAL_connectDynamicWidgets = deprecate(connectDynamicWidgets, 'use connectDynamicWidgets');
+export { connectDynamicWidgets };
 export { default as connectClearRefinements } from "./clear-refinements/connectClearRefinements.js";
 export { default as connectCurrentRefinements } from "./current-refinements/connectCurrentRefinements.js";
 export { default as connectHierarchicalMenu } from "./hierarchical-menu/connectHierarchicalMenu.js";
@@ -25,13 +34,4 @@ export { default as EXPERIMENTAL_connectConfigureRelatedItems } from "./configur
 export { default as connectAutocomplete } from "./autocomplete/connectAutocomplete.js";
 export { default as connectQueryRules } from "./query-rules/connectQueryRules.js";
 export { default as connectVoiceSearch } from "./voice-search/connectVoiceSearch.js";
-import connectAnswers from "./answers/connectAnswers.js";
-
-/** @deprecated answers is no longer supported */
-export var EXPERIMENTAL_connectAnswers = deprecate(connectAnswers, 'answers is no longer supported');
-export { default as connectRelevantSort } from "./relevant-sort/connectRelevantSort.js";
-import connectDynamicWidgets from "./dynamic-widgets/connectDynamicWidgets.js";
-export { connectDynamicWidgets };
-
-/** @deprecated use connectDynamicWidgets */
-export var EXPERIMENTAL_connectDynamicWidgets = deprecate(connectDynamicWidgets, 'use connectDynamicWidgets');
+export { default as connectRelevantSort } from "./relevant-sort/connectRelevantSort.js";

package/es/connectors/infinite-hits/connectInfiniteHits.d.ts

@@ -1,6 +1,6 @@
-import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
-import type { Connector, TransformItems, Hit, WidgetRenderState, BaseHit } from '../../types';
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
+import type { Connector, TransformItems, Hit, WidgetRenderState, BaseHit } from '../../types';
+import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
 export type InfiniteHitsCachedHits<THit extends BaseHit> = {
     [page: number]: Array<Hit<THit>>;
 };

package/es/connectors/menu/connectMenu.d.ts

@@ -1,6 +1,6 @@
-import type { SearchResults } from 'algoliasearch-helper';
 import type { SendEventForFacet } from '../../lib/utils';
 import type { Connector, CreateURL, SortBy, TransformItems, WidgetRenderState } from '../../types';
+import type { SearchResults } from 'algoliasearch-helper';
 export type MenuItem = {
     /**
      * The value of the menu item.

package/es/connectors/rating-menu/connectRatingMenu.d.ts

@@ -1,5 +1,5 @@
-import type { Connector, CreateURL, WidgetRenderState } from '../../types';
 import type { InsightsEvent } from '../../middlewares';
+import type { Connector, CreateURL, WidgetRenderState } from '../../types';
 type SendEvent = (...args: [InsightsEvent] | [string, string, string?]) => void;
 type StarRatingItems = {
     /**

package/es/connectors/refinement-list/connectRefinementList.d.ts

@@ -1,6 +1,6 @@
-import type { SearchResults } from 'algoliasearch-helper';
 import type { SendEventForFacet } from '../../lib/utils';
 import type { Connector, TransformItems, SortBy, CreateURL, WidgetRenderState } from '../../types';
+import type { SearchResults } from 'algoliasearch-helper';
 export type RefinementListItem = {
     /**
      * The value of the refinement list item.

package/es/connectors/voice-search/connectVoiceSearch.d.ts

@@ -1,6 +1,6 @@
-import type { PlainSearchParameters } from 'algoliasearch-helper';
-import type { Connector, WidgetRenderState } from '../../types';
 import type { CreateVoiceSearchHelper, VoiceListeningState } from '../../lib/voiceSearchHelper/types';
+import type { Connector, WidgetRenderState } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 export type VoiceSearchConnectorParams = {
     searchAsYouSpeak?: boolean;
     language?: string;

package/es/helpers/components/Highlight.d.ts

@@ -1,7 +1,7 @@
 
 import { h } from 'preact';
-import type { BaseHit, Hit, PartialKeys } from '../../types';
 import type { HighlightProps as HighlightUiComponentProps } from '../../components/Highlight/Highlight';
+import type { BaseHit, Hit, PartialKeys } from '../../types';
 export type HighlightProps<THit extends Hit<BaseHit>> = {
     hit: THit;
     attribute: keyof THit | string[];

package/es/helpers/components/ReverseHighlight.d.ts

@@ -1,7 +1,7 @@
 
 import { h } from 'preact';
-import type { BaseHit, Hit, PartialKeys } from '../../types';
 import type { ReverseHighlightProps as ReverseHighlightUiComponentProps } from '../../components/ReverseHighlight/ReverseHighlight';
+import type { BaseHit, Hit, PartialKeys } from '../../types';
 export type ReverseHighlightProps<THit extends Hit<BaseHit>> = {
     hit: THit;
     attribute: keyof THit | string[];

package/es/helpers/components/ReverseSnippet.d.ts

@@ -1,7 +1,7 @@
 
 import { h } from 'preact';
-import type { BaseHit, Hit, PartialKeys } from '../../types';
 import type { ReverseSnippetProps as ReverseSnippetUiComponentProps } from '../../components/ReverseSnippet/ReverseSnippet';
+import type { BaseHit, Hit, PartialKeys } from '../../types';
 export type ReverseSnippetProps<THit extends Hit<BaseHit>> = {
     hit: THit;
     attribute: keyof THit | string[];

package/es/helpers/components/Snippet.d.ts

@@ -1,7 +1,7 @@
 
 import { h } from 'preact';
-import type { BaseHit, Hit, PartialKeys } from '../../types';
 import type { SnippetProps as SnippetUiComponentProps } from '../../components/Snippet/Snippet';
+import type { BaseHit, Hit, PartialKeys } from '../../types';
 export type SnippetProps<THit extends Hit<BaseHit>> = {
     hit: THit;
     attribute: keyof THit | string[];

package/es/helpers/reverseHighlight.js

@@ -1,5 +1,5 @@
-import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 import { component } from "../lib/suit.js";
+import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 var suit = component('ReverseHighlight');
 export default function reverseHighlight(_ref) {
   var attribute = _ref.attribute,

package/es/helpers/reverseSnippet.js

@@ -1,5 +1,5 @@
-import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 import { component } from "../lib/suit.js";
+import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 var suit = component('ReverseSnippet');
 export default function reverseSnippet(_ref) {
   var attribute = _ref.attribute,

package/es/index.d.ts

@@ -1,8 +1,8 @@
-import type { Expand, UiState } from './types';
-import type { InstantSearchOptions } from './lib/InstantSearch';
-import InstantSearch from './lib/InstantSearch';
 import { snippet, reverseSnippet, highlight, reverseHighlight, insights, getInsightsAnonymousUserToken } from './helpers';
 import { createInfiniteHitsSessionStorageCache } from './lib/infiniteHitsCache';
+import InstantSearch from './lib/InstantSearch';
+import type { InstantSearchOptions } from './lib/InstantSearch';
+import type { Expand, UiState } from './types';
 type InstantSearchModule = {
     <TUiState = Record<string, unknown>, TRouteState = TUiState>(options: InstantSearchOptions<Expand<UiState & TUiState>, TRouteState>): InstantSearch<Expand<UiState & TUiState>, TRouteState>;
     version: string;

package/es/index.js

@@ -1,8 +1,8 @@
-import InstantSearch from "./lib/InstantSearch.js";
-import version from "./lib/version.js";
 import { snippet, reverseSnippet, highlight, reverseHighlight, insights, getInsightsAnonymousUserToken } from "./helpers/index.js";
 import { createInfiniteHitsSessionStorageCache } from "./lib/infiniteHitsCache/index.js";
+import InstantSearch from "./lib/InstantSearch.js";
 import { deprecate } from "./lib/utils/index.js";
+import version from "./lib/version.js";
 /**
  * InstantSearch is the main component of InstantSearch.js. This object
  * manages the widget and lets you add new ones.

package/es/lib/InstantSearch.d.ts

@@ -1,9 +1,9 @@
-import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import EventEmitter from '@algolia/events';
-import type { IndexWidget } from '../widgets/index/index';
-import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
-import type { RouterProps } from '../middlewares/createRouterMiddleware';
 import type { InsightsEvent } from '../middlewares/createInsightsMiddleware';
+import type { RouterProps } from '../middlewares/createRouterMiddleware';
+import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
+import type { IndexWidget } from '../widgets/index/index';
+import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 type NoInfer<T> = T extends infer S ? S : never;
 /**
  * Global options for an InstantSearch instance.
@@ -50,6 +50,7 @@ export type InstantSearchOptions<TUiState extends UiState = UiState, TRouteState
      * A hook that will be called each time a search needs to be done, with the
      * helper as a parameter. It's your responsibility to call `helper.search()`.
      * This option allows you to avoid doing searches at page load for example.
+     * @deprecated use onStateChange instead
      */
     searchFunction?: (helper: AlgoliaSearchHelper) => void;
     /**

package/es/lib/InstantSearch.js

@@ -14,14 +14,14 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 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 algoliasearchHelper from 'algoliasearch-helper';
 import EventEmitter from '@algolia/events';
+import algoliasearchHelper from 'algoliasearch-helper';
+import { createMetadataMiddleware, isMetadataEnabled } from "../middlewares/createMetadataMiddleware.js";
+import { createRouterMiddleware } from "../middlewares/createRouterMiddleware.js";
 import index from "../widgets/index/index.js";
-import version from "./version.js";
 import createHelpers from "./createHelpers.js";
 import { createDocumentationMessageGenerator, createDocumentationLink, defer, noop, warning, setIndexHelperState } from "./utils/index.js";
-import { createRouterMiddleware } from "../middlewares/createRouterMiddleware.js";
-import { createMetadataMiddleware, isMetadataEnabled } from "../middlewares/createMetadataMiddleware.js";
+import version from "./version.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'instantsearch'
 });
@@ -155,6 +155,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _this._initialUiState = initialUiState;
     _this._initialResults = null;
     if (searchFunction) {
+      process.env.NODE_ENV === 'development' ? warning(false, "The `searchFunction` option is deprecated. Use `onStateChange` instead.") : void 0;
       _this._searchFunction = searchFunction;
     }
     _this.sendEventToInsights = noop;
@@ -463,6 +464,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
   }, {
     key: "dispose",
     value: function dispose() {
+      var _this$mainHelper2;
       this.scheduleSearch.cancel();
       this.scheduleRender.cancel();
       clearTimeout(this._searchStalledTimer);
@@ -477,7 +479,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       // The helper needs to be reset to perform the next search from a fresh state.
       // If not reset, it would use the state stored before calling `dispose()`.
       this.removeAllListeners();
-      this.mainHelper.removeAllListeners();
+      (_this$mainHelper2 = this.mainHelper) === null || _this$mainHelper2 === void 0 ? void 0 : _this$mainHelper2.removeAllListeners();
       this.mainHelper = null;
       this.helper = null;
       this.middleware.forEach(function (_ref7) {

package/es/lib/insights/client.d.ts

@@ -1,5 +1,5 @@
-import type { SearchResults } from 'algoliasearch-helper';
 import type { Hit, InsightsClientMethod, InsightsClientPayload, Connector } from '../../types';
+import type { SearchResults } from 'algoliasearch-helper';
 export declare const inferPayload: ({ method, results, hits, objectIDs, }: {
     method: InsightsClientMethod;
     results: SearchResults;

package/es/lib/insights/listener.d.ts

@@ -1,7 +1,7 @@
 
 import { h } from 'preact';
-import type { InsightsClient } from '../../types';
 import type { InsightsEvent } from '../../middlewares/createInsightsMiddleware';
+import type { InsightsClient } from '../../types';
 type WithInsightsListenerProps = {
     [key: string]: unknown;
     insights: InsightsClient;

package/es/lib/insights/listener.js

@@ -1,6 +1,6 @@
 import { h } from 'preact';
-import { deserializePayload } from "../utils/index.js";
 import { readDataAttributes, hasDataAttributes } from "../../helpers/insights.js";
+import { deserializePayload } from "../utils/index.js";
 var findInsightsTarget = function findInsightsTarget(startElement, endElement, validator) {
   var element = startElement;
   while (element && !validator(element)) {

package/es/lib/routers/history.d.ts

@@ -97,6 +97,7 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * Removes the event listener and cleans up the URL.
      */
     dispose(): void;
+    start(): void;
     private shouldWrite;
 }
 export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;

package/es/lib/routers/history.js

@@ -171,6 +171,11 @@ var BrowserHistory = /*#__PURE__*/function () {
       }
       this.write({});
     }
+  }, {
+    key: "start",
+    value: function start() {
+      this.isDisposed = false;
+    }
   }, {
     key: "shouldWrite",
     value: function shouldWrite(url) {

package/es/lib/templating/renderTemplate.d.ts

@@ -1,6 +1,6 @@
-import type { HoganOptions } from 'hogan.js';
 import type { Templates, HoganHelpers } from '../../types';
 import type { BindEventForHits, SendEventForHits } from '../utils/createSendEventForHits';
+import type { HoganOptions } from 'hogan.js';
 export declare function renderTemplate({ templates, templateKey, compileOptions, helpers, data, bindEvent, sendEvent, }: {
     templates: Templates;
     templateKey: string;

package/es/lib/utils/checkIndexUiState.d.ts

@@ -1,5 +1,5 @@
-import type { IndexWidget } from '../../widgets/index/index';
 import type { IndexUiState } from '../../types';
+import type { IndexWidget } from '../../widgets/index/index';
 type CheckIndexUiStateParams = {
     index: IndexWidget;
     indexUiState: IndexUiState;

package/es/lib/utils/checkIndexUiState.js

@@ -11,7 +11,6 @@ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 import { capitalize } from "./capitalize.js";
 import { warning } from "./logger.js";
 import { keys } from "./typedObject.js";
-
 // Some connectors are responsible for multiple widgets so we need
 // to map them.
 function getWidgetNames(connectorName) {

package/es/lib/utils/createSendEventForFacet.d.ts

@@ -1,5 +1,5 @@
-import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import type { InstantSearch } from '../../types';
+import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 type BuiltInSendEventForFacet = (eventType: string, facetValue: string, eventName?: string) => void;
 type CustomSendEventForFacet = (customPayload: any) => void;
 export type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;

package/es/lib/utils/createSendEventForHits.js

@@ -35,7 +35,7 @@ var buildPayloads = function buildPayloads(_ref) {
       return [];
     }
   }
-  var hitsArray = Array.isArray(hits) ? removeEscapedFromHits(hits) : [hits];
+  var hitsArray = Array.isArray(hits) ? hits : [hits];
   if (hitsArray.length === 0) {
     return [];
   }
@@ -105,10 +105,6 @@ var buildPayloads = function buildPayloads(_ref) {
     return [];
   }
 };
-function removeEscapedFromHits(hits) {
-  // remove `hits.__escaped` without mutating
-  return hits.slice();
-}
 export function createSendEventForHits(_ref2) {
   var instantSearchInstance = _ref2.instantSearchInstance,
     index = _ref2.index,

package/es/lib/utils/getRefinements.js

@@ -1,5 +1,5 @@
-import { find } from "./find.js";
 import { unescapeFacetValue, escapeFacetValue } from "./escapeFacetValue.js";
+import { find } from "./find.js";
 function getRefinement(state, type, attribute, name) {
   var resultsFacets = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
   var res = {

package/es/lib/utils/index.d.ts

@@ -35,6 +35,7 @@ export * from './isPlainObject';
 export * from './isSpecialClick';
 export * from './logger';
 export * from './mergeSearchParameters';
+export * from './omit';
 export * from './noop';
 export * from './range';
 export * from './render-args';

package/es/lib/utils/index.js

@@ -35,6 +35,7 @@ export * from "./isPlainObject.js";
 export * from "./isSpecialClick.js";
 export * from "./logger.js";
 export * from "./mergeSearchParameters.js";
+export * from "./omit.js";
 export * from "./noop.js";
 export * from "./range.js";
 export * from "./render-args.js";

package/es/lib/utils/omit.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Creates a new object with the same keys as the original object, but without the excluded keys.
+ * @param source original object
+ * @param excluded keys to remove from the original object
+ * @returns the new object
+ */
+export declare function omit<TSource extends Record<string, unknown>, TExcluded extends keyof TSource>(source: TSource, excluded: TExcluded[]): Omit<TSource, TExcluded>;

package/es/lib/utils/omit.js

@@ -0,0 +1,19 @@
+/**
+ * Creates a new object with the same keys as the original object, but without the excluded keys.
+ * @param source original object
+ * @param excluded keys to remove from the original object
+ * @returns the new object
+ */
+export function omit(source, excluded) {
+  if (source === null || source === undefined) {
+    return source;
+  }
+  return Object.keys(source).reduce(function (target, key) {
+    if (excluded.indexOf(key) >= 0) {
+      return target;
+    }
+    var validKey = key;
+    target[validKey] = source[validKey];
+    return target;
+  }, {});
+}

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

@@ -3,7 +3,7 @@ import type { IndexWidget } from '../../widgets/index/index';
 export declare function createInitArgs(instantSearchInstance: InstantSearch, parent: IndexWidget, uiState: UiState): {
     uiState: UiState;
     helper: import("algoliasearch-helper").AlgoliaSearchHelper;
-    parent: IndexWidget;
+    parent: IndexWidget<UiState>;
     instantSearchInstance: InstantSearch<UiState, UiState>;
     state: import("algoliasearch-helper").SearchParameters;
     renderState: import("../../types").RenderState;
@@ -18,7 +18,7 @@ export declare function createInitArgs(instantSearchInstance: InstantSearch, par
 };
 export declare function createRenderArgs(instantSearchInstance: InstantSearch, parent: IndexWidget): {
     helper: import("algoliasearch-helper").AlgoliaSearchHelper;
-    parent: IndexWidget;
+    parent: IndexWidget<UiState>;
     instantSearchInstance: InstantSearch<UiState, UiState>;
     results: import("algoliasearch-helper").SearchResults<any>;
     scopedResults: import("../../types").ScopedResult[];

package/es/lib/utils/resolveSearchParameters.d.ts

@@ -1,3 +1,3 @@
-import type { SearchParameters } from 'algoliasearch-helper';
 import type { IndexWidget } from '../../widgets/index/index';
+import type { SearchParameters } from 'algoliasearch-helper';
 export declare function resolveSearchParameters(current: IndexWidget): SearchParameters[];

package/es/lib/utils/setIndexHelperState.js

@@ -1,5 +1,5 @@
-import { isIndexWidget } from "./isIndexWidget.js";
 import { checkIndexUiState } from "./checkIndexUiState.js";
+import { isIndexWidget } from "./isIndexWidget.js";
 export function setIndexHelperState(finalUiState, indexWidget) {
   var nextIndexUiState = finalUiState[indexWidget.getIndexId()] || {};
   if (process.env.NODE_ENV === 'development') {

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.51.0";
+declare const _default: "4.52.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.51.0';
+export default '4.52.0';

package/es/middlewares/createRouterMiddleware.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 simpleStateMapping from "../lib/stateMappings/simple.js";
 import historyRouter from "../lib/routers/history.js";
+import simpleStateMapping from "../lib/stateMappings/simple.js";
 import { isEqual } from "../lib/utils/index.js";
 export var createRouterMiddleware = function createRouterMiddleware() {
   var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -43,7 +43,10 @@ export var createRouterMiddleware = function createRouterMiddleware() {
           instantSearchInstance.setUiState(stateMapping.routeToState(route));
         });
       },
-      started: function started() {},
+      started: function started() {
+        var _router$start;
+        (_router$start = router.start) === null || _router$start === void 0 ? void 0 : _router$start.call(router);
+      },
       unsubscribe: function unsubscribe() {
         router.dispose();
       }

package/es/types/connector.d.ts

@@ -1,8 +1,8 @@
-import type { SearchResults } from 'algoliasearch-helper';
-import type { InstantSearch } from './instantsearch';
 import type { InsightsClient } from './insights';
+import type { InstantSearch } from './instantsearch';
 import type { Hit } from './results';
 import type { UnknownWidgetParams, Widget, WidgetDescription } from './widget';
+import type { SearchResults } from 'algoliasearch-helper';
 /**
  * The base renderer options. All render functions receive
  * the options below plus the specific options per connector.

package/es/types/index.d.ts

@@ -12,3 +12,4 @@ export * from './widget';
 export * from './ui-state';
 export * from './render-state';
 export * from './templates';
+export type { IndexWidget } from '../widgets/index/index';

package/es/types/index.js

@@ -21,4 +21,7 @@ export * from "./widget-factory.js";
 export * from "./widget.js";
 export * from "./ui-state.js";
 export * from "./render-state.js";
-export * from "./templates.js";
+export * from "./templates.js";
+
+// from specific widgets
+export {};

package/es/types/router.d.ts

@@ -30,6 +30,10 @@ export type Router<TRouteState = UiState> = {
      * Called when InstantSearch is disposed. Used to remove subscriptions.
      */
     dispose(): void;
+    /**
+     * Called when InstantSearch is started.
+     */
+    start?: () => void;
 };
 /**
  * The state mapping is a way to customize the structure before sending it to the router.

package/es/types/templates.d.ts

@@ -1,7 +1,7 @@
-import type { VNode } from 'preact';
 import type { Highlight, ReverseHighlight, ReverseSnippet, Snippet } from '../helpers/components';
-import type { html } from 'htm/preact';
 import type { BuiltInBindEventForHits, CustomBindEventForHits, SendEventForHits } from '../lib/utils';
+import type { html } from 'htm/preact';
+import type { VNode } from 'preact';
 export type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string);
 export type TemplateParams = {
     html: typeof html;

package/es/types/widget.d.ts

@@ -1,9 +1,9 @@
 import type { IndexWidget } from '../widgets/index/index';
-import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 import type { InstantSearch } from './instantsearch';
-import type { IndexUiState, UiState } from './ui-state';
 import type { IndexRenderState, WidgetRenderState } from './render-state';
+import type { IndexUiState, UiState } from './ui-state';
 import type { Expand, RequiredKeys } from './utils';
+import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 export type ScopedResult = {
     indexId: string;
     results: SearchResults;

package/es/widgets/analytics/analytics.d.ts

@@ -1,5 +1,5 @@
-import type { SearchParameters, SearchResults } from 'algoliasearch-helper';
 import type { WidgetFactory, WidgetRenderState } from '../../types';
+import type { SearchParameters, SearchResults } from 'algoliasearch-helper';
 export type AnalyticsWidgetParamsPushFunction = (
 /**
  * Contains the search parameters, serialized as a query string.

package/es/widgets/answers/answers.d.ts

@@ -1,6 +1,6 @@
 
-import type { WidgetFactory, Template, Hit } from '../../types';
 import type { AnswersConnectorParams, AnswersWidgetDescription } from '../../connectors/answers/connectAnswers';
+import type { WidgetFactory, Template, Hit } from '../../types';
 export type AnswersTemplates = Partial<{
     /**
      * Template to use for the header. This template will receive an object containing `hits` and `isLoading`.

package/es/widgets/answers/answers.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 defaultTemplates from "./defaultTemplates.js";
-import { createDocumentationMessageGenerator, getContainerNode } from "../../lib/utils/index.js";
-import { prepareTemplateProps } from "../../lib/templating/index.js";
-import { component } from "../../lib/suit.js";
+import { h, render } from 'preact';
 import Answers from "../../components/Answers/Answers.js";
 import connectAnswers from "../../connectors/answers/connectAnswers.js";
+import { component } from "../../lib/suit.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { createDocumentationMessageGenerator, getContainerNode } from "../../lib/utils/index.js";
+import defaultTemplates from "./defaultTemplates.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'answers'
 });

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'
 });