instantsearch.js 4.51.1 → 4.53.0

package/dist/instantsearch.production.d.ts

@@ -515,6 +515,7 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * Removes the event listener and cleans up the URL.
      */
     dispose(): void;
+    start(): void;
     private shouldWrite;
 }
 
@@ -785,6 +786,9 @@ declare type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'
 
 declare namespace connectors {
     export {
+        EXPERIMENTAL_connectAnswers,
+        EXPERIMENTAL_connectDynamicWidgets,
+        connectDynamicWidgets,
         connectClearRefinements,
         connectCurrentRefinements,
         connectHierarchicalMenu,
@@ -811,10 +815,7 @@ declare namespace connectors {
         connectAutocomplete,
         connectQueryRules,
         connectVoiceSearch,
-        EXPERIMENTAL_connectAnswers,
-        connectRelevantSort,
-        connectDynamicWidgets,
-        EXPERIMENTAL_connectDynamicWidgets
+        connectRelevantSort
     }
 }
 
@@ -956,6 +957,10 @@ declare type CurrentRefinementsConnectorParamsItem = {
      * The index name.
      */
     indexName: string;
+    /**
+     * The index id as provided to the index widget.
+     */
+    indexId: string;
     /**
      * The attribute on which the refinement is applied.
      */
@@ -1992,6 +1997,7 @@ declare type HitsTemplates = Partial<{
      * @default ''
      */
     item: TemplateWithBindEvent<Hit & {
+        /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
 }>;
@@ -2054,7 +2060,7 @@ declare type IndexRenderState = Partial<ConnectorRenderStates & WidgetRenderStat
 
 declare type IndexUiState = Partial<ConnectorUiStates & WidgetUiStates>;
 
-declare type IndexWidget = Omit<Widget<IndexWidgetDescription & {
+declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexWidgetDescription & {
     widgetParams: IndexWidgetParams;
 }>, 'getWidgetUiState' | 'getWidgetState'> & {
     getIndexName(): string;
@@ -2075,11 +2081,21 @@ declare 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 type IndexWidgetDescription = {
@@ -2222,6 +2238,7 @@ declare 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;
     }>;
 }>;
@@ -2514,6 +2531,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * 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;
     /**
@@ -4520,6 +4538,10 @@ declare type Router<TRouteState = UiState> = {
      * Called when InstantSearch is disposed. Used to remove subscriptions.
      */
     dispose(): void;
+    /**
+     * Called when InstantSearch is started.
+     */
+    start?: () => void;
 };
 
 declare type RouterProps<TUiState extends UiState = UiState, TRouteState = TUiState> = {
@@ -5393,15 +5415,15 @@ declare type WidgetRenderStates = AnalyticsWidgetDescription['indexRenderState']
 
 declare namespace widgets {
     export {
+        EXPERIMENTAL_answers,
+        EXPERIMENTAL_dynamicWidgets,
+        dynamicWidgets,
         analytics,
         breadcrumb,
         clearRefinements,
         configure,
         currentRefinements,
-        EXPERIMENTAL_answers,
         configureRelatedItems as EXPERIMENTAL_configureRelatedItems,
-        dynamicWidgets,
-        EXPERIMENTAL_dynamicWidgets,
         geoSearch,
         hierarchicalMenu,
         hits,

package/dist/instantsearch.production.min.d.ts

@@ -515,6 +515,7 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * Removes the event listener and cleans up the URL.
      */
     dispose(): void;
+    start(): void;
     private shouldWrite;
 }
 
@@ -785,6 +786,9 @@ declare type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'
 
 declare namespace connectors {
     export {
+        EXPERIMENTAL_connectAnswers,
+        EXPERIMENTAL_connectDynamicWidgets,
+        connectDynamicWidgets,
         connectClearRefinements,
         connectCurrentRefinements,
         connectHierarchicalMenu,
@@ -811,10 +815,7 @@ declare namespace connectors {
         connectAutocomplete,
         connectQueryRules,
         connectVoiceSearch,
-        EXPERIMENTAL_connectAnswers,
-        connectRelevantSort,
-        connectDynamicWidgets,
-        EXPERIMENTAL_connectDynamicWidgets
+        connectRelevantSort
     }
 }
 
@@ -956,6 +957,10 @@ declare type CurrentRefinementsConnectorParamsItem = {
      * The index name.
      */
     indexName: string;
+    /**
+     * The index id as provided to the index widget.
+     */
+    indexId: string;
     /**
      * The attribute on which the refinement is applied.
      */
@@ -1992,6 +1997,7 @@ declare type HitsTemplates = Partial<{
      * @default ''
      */
     item: TemplateWithBindEvent<Hit & {
+        /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
 }>;
@@ -2054,7 +2060,7 @@ declare type IndexRenderState = Partial<ConnectorRenderStates & WidgetRenderStat
 
 declare type IndexUiState = Partial<ConnectorUiStates & WidgetUiStates>;
 
-declare type IndexWidget = Omit<Widget<IndexWidgetDescription & {
+declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexWidgetDescription & {
     widgetParams: IndexWidgetParams;
 }>, 'getWidgetUiState' | 'getWidgetState'> & {
     getIndexName(): string;
@@ -2075,11 +2081,21 @@ declare 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 type IndexWidgetDescription = {
@@ -2222,6 +2238,7 @@ declare 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;
     }>;
 }>;
@@ -2514,6 +2531,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * 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;
     /**
@@ -4520,6 +4538,10 @@ declare type Router<TRouteState = UiState> = {
      * Called when InstantSearch is disposed. Used to remove subscriptions.
      */
     dispose(): void;
+    /**
+     * Called when InstantSearch is started.
+     */
+    start?: () => void;
 };
 
 declare type RouterProps<TUiState extends UiState = UiState, TRouteState = TUiState> = {
@@ -5393,15 +5415,15 @@ declare type WidgetRenderStates = AnalyticsWidgetDescription['indexRenderState']
 
 declare namespace widgets {
     export {
+        EXPERIMENTAL_answers,
+        EXPERIMENTAL_dynamicWidgets,
+        dynamicWidgets,
         analytics,
         breadcrumb,
         clearRefinements,
         configure,
         currentRefinements,
-        EXPERIMENTAL_answers,
         configureRelatedItems as EXPERIMENTAL_configureRelatedItems,
-        dynamicWidgets,
-        EXPERIMENTAL_dynamicWidgets,
         geoSearch,
         hierarchicalMenu,
         hits,