instantsearch.js 4.46.0 → 4.46.2

package/dist/instantsearch.production.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<{

package/dist/instantsearch.production.min.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<{