instantsearch.js 4.43.1 → 4.45.0

package/dist/instantsearch.production.d.ts

@@ -1169,7 +1169,7 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
-declare type GeoHit = Hit & Required<Pick<Hit, '_geoloc'>>;
+declare type GeoHit<THit extends BaseHit = Record<string, any>> = Hit<THit> & Required<Pick<Hit, '_geoloc'>>;
 
 declare type GeoLoc = {
     lat: number;
@@ -1191,9 +1191,9 @@ declare type GeoLoc = {
  */
 declare const geoSearch: GeoSearchWidget;
 
-declare type GeoSearchConnector = Connector<GeoSearchWidgetDescription, GeoSearchConnectorParams>;
+declare type GeoSearchConnector<THit extends BaseHit = Record<string, any>> = Connector<GeoSearchWidgetDescription<THit>, GeoSearchConnectorParams<THit>>;
 
-declare type GeoSearchConnectorParams = {
+declare type GeoSearchConnectorParams<THit extends BaseHit = Record<string, any>> = {
     /**
      * If true, refine will be triggered as you move the map.
      * @default true
@@ -1203,7 +1203,7 @@ declare type GeoSearchConnectorParams = {
      * Function to transform the items passed to the templates.
      * @default items => items
      */
-    transformItems?: TransformItems<GeoHit>;
+    transformItems?: TransformItems<GeoHit<THit>>;
 };
 
 declare type GeoSearchCSSClasses = Partial<{
@@ -1249,7 +1249,7 @@ declare type GeoSearchMarker<TOptions> = {
     };
 };
 
-declare type GeoSearchRenderState = {
+declare type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Reset the current bounding box refinement.
      */
@@ -1273,7 +1273,7 @@ declare type GeoSearchRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    items: GeoHit[];
+    items: Array<GeoHit<THit>>;
     /**
      * The current position of the search.
      */
@@ -1313,11 +1313,11 @@ declare type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
     $$widgetType: 'ais.geoSearch';
 }, GeoSearchConnectorParams, GeoSearchWidgetParams>;
 
-declare type GeoSearchWidgetDescription = {
+declare type GeoSearchWidgetDescription<THit extends BaseHit = Record<string, any>> = {
     $$type: 'ais.geoSearch';
-    renderState: GeoSearchRenderState;
+    renderState: GeoSearchRenderState<THit>;
     indexRenderState: {
-        geoSearch: WidgetRenderState<GeoSearchRenderState, GeoSearchConnectorParams>;
+        geoSearch: WidgetRenderState<GeoSearchRenderState<THit>, GeoSearchConnectorParams<THit>>;
     };
     indexUiState: {
         geoSearch: {
@@ -1872,8 +1872,13 @@ declare type HitsPerPageRenderState = {
     refine: (value: number) => void;
     /**
      * Indicates whether or not the search has results.
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * Indicates if search state can be refined.
+     */
+    canRefine: boolean;
 };
 
 declare type HitsPerPageRenderStateItem = {
@@ -2855,8 +2860,16 @@ declare type NumericMenuRenderState = {
     createURL: CreateURL<NumericMenuRenderStateItem['value']>;
     /**
      * `true` if the last search contains no result
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * Indicates if search state can be refined.
+     *
+     * This is `true` if the last search contains no result and
+     * "All" range is selected
+     */
+    canRefine: boolean;
     /**
      * Sets the selected value and trigger a new search
      */
@@ -3721,6 +3734,8 @@ declare type RatingMenuRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     *
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
     /**
@@ -4683,8 +4698,13 @@ declare type SortByRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * `true` if we can refine.
+     */
+    canRefine: boolean;
 };
 
 declare type SortByWidget = WidgetFactory<SortByWidgetDescription & {

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

@@ -1169,7 +1169,7 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
-declare type GeoHit = Hit & Required<Pick<Hit, '_geoloc'>>;
+declare type GeoHit<THit extends BaseHit = Record<string, any>> = Hit<THit> & Required<Pick<Hit, '_geoloc'>>;
 
 declare type GeoLoc = {
     lat: number;
@@ -1191,9 +1191,9 @@ declare type GeoLoc = {
  */
 declare const geoSearch: GeoSearchWidget;
 
-declare type GeoSearchConnector = Connector<GeoSearchWidgetDescription, GeoSearchConnectorParams>;
+declare type GeoSearchConnector<THit extends BaseHit = Record<string, any>> = Connector<GeoSearchWidgetDescription<THit>, GeoSearchConnectorParams<THit>>;
 
-declare type GeoSearchConnectorParams = {
+declare type GeoSearchConnectorParams<THit extends BaseHit = Record<string, any>> = {
     /**
      * If true, refine will be triggered as you move the map.
      * @default true
@@ -1203,7 +1203,7 @@ declare type GeoSearchConnectorParams = {
      * Function to transform the items passed to the templates.
      * @default items => items
      */
-    transformItems?: TransformItems<GeoHit>;
+    transformItems?: TransformItems<GeoHit<THit>>;
 };
 
 declare type GeoSearchCSSClasses = Partial<{
@@ -1249,7 +1249,7 @@ declare type GeoSearchMarker<TOptions> = {
     };
 };
 
-declare type GeoSearchRenderState = {
+declare type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Reset the current bounding box refinement.
      */
@@ -1273,7 +1273,7 @@ declare type GeoSearchRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    items: GeoHit[];
+    items: Array<GeoHit<THit>>;
     /**
      * The current position of the search.
      */
@@ -1313,11 +1313,11 @@ declare type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
     $$widgetType: 'ais.geoSearch';
 }, GeoSearchConnectorParams, GeoSearchWidgetParams>;
 
-declare type GeoSearchWidgetDescription = {
+declare type GeoSearchWidgetDescription<THit extends BaseHit = Record<string, any>> = {
     $$type: 'ais.geoSearch';
-    renderState: GeoSearchRenderState;
+    renderState: GeoSearchRenderState<THit>;
     indexRenderState: {
-        geoSearch: WidgetRenderState<GeoSearchRenderState, GeoSearchConnectorParams>;
+        geoSearch: WidgetRenderState<GeoSearchRenderState<THit>, GeoSearchConnectorParams<THit>>;
     };
     indexUiState: {
         geoSearch: {
@@ -1872,8 +1872,13 @@ declare type HitsPerPageRenderState = {
     refine: (value: number) => void;
     /**
      * Indicates whether or not the search has results.
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * Indicates if search state can be refined.
+     */
+    canRefine: boolean;
 };
 
 declare type HitsPerPageRenderStateItem = {
@@ -2855,8 +2860,16 @@ declare type NumericMenuRenderState = {
     createURL: CreateURL<NumericMenuRenderStateItem['value']>;
     /**
      * `true` if the last search contains no result
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * Indicates if search state can be refined.
+     *
+     * This is `true` if the last search contains no result and
+     * "All" range is selected
+     */
+    canRefine: boolean;
     /**
      * Sets the selected value and trigger a new search
      */
@@ -3721,6 +3734,8 @@ declare type RatingMenuRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     *
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
     /**
@@ -4683,8 +4698,13 @@ declare type SortByRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * `true` if we can refine.
+     */
+    canRefine: boolean;
 };
 
 declare type SortByWidget = WidgetFactory<SortByWidgetDescription & {