instantsearch.js 4.44.0 → 4.45.1

package/dist/instantsearch.production.d.ts

@@ -173,7 +173,7 @@ declare type AnswersRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Hit[];
     /**
      * Whether it's still loading the results from the Answers API.
      */
@@ -264,7 +264,7 @@ declare type AutocompleteRenderState = {
         /**
          * The resolved hits from the index matching the query.
          */
-        hits: Hits;
+        hits: Hit[];
         /**
          * The full results object from the Algolia API.
          */
@@ -518,11 +518,11 @@ declare type BrowserHistoryArgs<TRouteState> = {
     getLocation(): Location;
 };
 
-declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
+declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => string;
 
 declare type BuiltInSendEventForFacet = (eventType: string, facetValue: string, eventName?: string) => void;
 
-declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => void;
+declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => void;
 
 declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
 
@@ -1769,11 +1769,6 @@ declare type HitHighlightResult = {
     [attribute: string]: HitAttributeHighlightResult | HitAttributeHighlightResult[] | HitHighlightResult[] | HitHighlightResult;
 };
 
-/**
- * @deprecated use Hit[] directly instead
- */
-declare type Hits = Hit[];
-
 declare const hits: HitsWidget;
 
 declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
@@ -1872,8 +1867,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 = {
@@ -2401,6 +2401,10 @@ declare type InstantSearchModule = {
     reverseHighlight: typeof helpers.reverseHighlight;
     snippet: typeof helpers.snippet;
     reverseSnippet: typeof helpers.reverseSnippet;
+    /**
+     * @deprecated use createInsightsMiddleware
+     * @link https://www.algolia.com/doc/api-reference/widgets/insights/js/
+     */
     insights: typeof helpers.insights;
 };
 
@@ -2855,8 +2859,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 +3733,8 @@ declare type RatingMenuRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     *
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
     /**
@@ -4240,7 +4254,7 @@ declare type RendererOptions<TWidgetParams> = {
      * The mutable list of hits. The may change depending
      * of the given transform items function.
      */
-    hits?: Hits;
+    hits?: Hit[];
     /**
      * The current insights client, if any.
      */
@@ -4683,8 +4697,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

@@ -173,7 +173,7 @@ declare type AnswersRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Hit[];
     /**
      * Whether it's still loading the results from the Answers API.
      */
@@ -264,7 +264,7 @@ declare type AutocompleteRenderState = {
         /**
          * The resolved hits from the index matching the query.
          */
-        hits: Hits;
+        hits: Hit[];
         /**
          * The full results object from the Algolia API.
          */
@@ -518,11 +518,11 @@ declare type BrowserHistoryArgs<TRouteState> = {
     getLocation(): Location;
 };
 
-declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
+declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => string;
 
 declare type BuiltInSendEventForFacet = (eventType: string, facetValue: string, eventName?: string) => void;
 
-declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => void;
+declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => void;
 
 declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
 
@@ -1769,11 +1769,6 @@ declare type HitHighlightResult = {
     [attribute: string]: HitAttributeHighlightResult | HitAttributeHighlightResult[] | HitHighlightResult[] | HitHighlightResult;
 };
 
-/**
- * @deprecated use Hit[] directly instead
- */
-declare type Hits = Hit[];
-
 declare const hits: HitsWidget;
 
 declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
@@ -1872,8 +1867,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 = {
@@ -2401,6 +2401,10 @@ declare type InstantSearchModule = {
     reverseHighlight: typeof helpers.reverseHighlight;
     snippet: typeof helpers.snippet;
     reverseSnippet: typeof helpers.reverseSnippet;
+    /**
+     * @deprecated use createInsightsMiddleware
+     * @link https://www.algolia.com/doc/api-reference/widgets/insights/js/
+     */
     insights: typeof helpers.insights;
 };
 
@@ -2855,8 +2859,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 +3733,8 @@ declare type RatingMenuRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     *
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
     /**
@@ -4240,7 +4254,7 @@ declare type RendererOptions<TWidgetParams> = {
      * The mutable list of hits. The may change depending
      * of the given transform items function.
      */
-    hits?: Hits;
+    hits?: Hit[];
     /**
      * The current insights client, if any.
      */
@@ -4683,8 +4697,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 & {