instantsearch.js 4.85.1 → 4.86.0

package/dist/instantsearch.production.d.ts

@@ -360,6 +360,14 @@ declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
          */
         storageKey?: string;
         templates?: Partial<{
+            /**
+             * Template to use for the header, before the list of items.
+             */
+            header: Template<{
+                items: Array<{
+                    query: string;
+                }>;
+            }>;
             /**
              * Template to use for each result. This template will receive an object containing a single record.
              */
@@ -371,6 +379,7 @@ declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
                 onRemoveRecentSearch: () => void;
             }>;
         }>;
+        cssClasses?: Partial<AutocompleteIndexClassNames>;
     };
     /**
      * Search parameters to apply to the autocomplete indices.
@@ -8154,7 +8163,7 @@ declare type SortByConnector = Connector<SortByWidgetDescription, SortByConnecto
 
 declare type SortByConnectorParams = {
     /**
-     * Array of objects defining the different indices to choose from.
+     * Array of objects defining the different indices or strategies to choose from.
      */
     items: SortByItem[];
     /**
@@ -8163,6 +8172,8 @@ declare type SortByConnectorParams = {
     transformItems?: TransformItems<SortByItem>;
 };
 
+declare type SortByDefinition = SortByIndexDefinition | SortByStrategyDefinition;
+
 declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
 
 declare type SortByIndexDefinition = {
@@ -8174,14 +8185,27 @@ declare type SortByIndexDefinition = {
      * The label of the index to display.
      */
     label: string;
+    /**
+     * Ensures mutual exclusivity with strategy.
+     */
+    strategy?: never;
 };
 
 /**
  * The **SortBy** connector provides the logic to build a custom widget that will display a
- * list of indices. With Algolia, this is most commonly used for changing ranking strategy. This allows
- * a user to change how the hits are being sorted.
+ * list of indices or sorting strategies. With Algolia, this is most commonly used for changing
+ * ranking strategy. This allows a user to change how the hits are being sorted.
+ *
+ * This connector supports two sorting modes:
+ * 1. **Index-based (traditional)**: Uses the `value` property to switch between different indices.
+ *    This is the standard behavior for non-composition setups.
+ *
+ * 2. **Strategy-based (composition mode)**: Uses the `strategy` property to apply sorting strategies
+ *    via the `sortBy` search parameter. This is only available when using Algolia Compositions.
+ *
+ * Items can mix both types in the same widget, allowing for flexible sorting options.
  */
-declare type SortByItem = {
+declare type SortByIndexItem = {
     /**
      * The name of the index to target.
      */
@@ -8190,23 +8214,32 @@ declare type SortByItem = {
      * The label of the index to display.
      */
     label: string;
+    /**
+     * Ensures mutual exclusivity with strategy.
+     */
+    strategy?: never;
 };
 
+declare type SortByItem = SortByIndexItem | SortByStrategyItem;
+
 declare type SortByRenderState = {
     /**
-     * The initially selected index.
+     * The initially selected index or strategy.
      */
     initialIndex?: string;
     /**
-     * The currently selected index.
+     * The currently selected index or strategy.
      */
     currentRefinement: string;
     /**
-     * All the available indices
+     * All the available indices and strategies
      */
-    options: SortByItem[];
+    options: Array<{
+        value: string;
+        label: string;
+    }>;
     /**
-     * Switches indices and triggers a new search.
+     * Switches indices or strategies and triggers a new search.
      */
     refine: (value: string) => void;
     /**
@@ -8220,6 +8253,38 @@ declare type SortByRenderState = {
     canRefine: boolean;
 };
 
+declare type SortByStrategyDefinition = {
+    /**
+     * The name of the sorting strategy to use.
+     * Only available in composition mode.
+     */
+    strategy: string;
+    /**
+     * The label of the strategy to display.
+     */
+    label: string;
+    /**
+     * Ensures mutual exclusivity with value.
+     */
+    value?: never;
+};
+
+declare type SortByStrategyItem = {
+    /**
+     * The name of the sorting strategy to use.
+     * Only available in composition mode.
+     */
+    strategy: string;
+    /**
+     * The label of the strategy to display.
+     */
+    label: string;
+    /**
+     * Ensures mutual exclusivity with value.
+     */
+    value?: never;
+};
+
 declare type SortByWidget = WidgetFactory<SortByWidgetDescription & {
     $$widgetType: 'ais.sortBy';
 }, SortByConnectorParams, SortByWidgetParams>;
@@ -8256,9 +8321,9 @@ declare type SortByWidgetParams = {
      */
     container: string | HTMLElement;
     /**
-     * Array of objects defining the different indices to choose from.
+     * Array of objects defining the different indices or strategies to choose from.
      */
-    items: SortByIndexDefinition[];
+    items: SortByDefinition[];
     /**
      * CSS classes to be added.
      */

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

@@ -360,6 +360,14 @@ declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
          */
         storageKey?: string;
         templates?: Partial<{
+            /**
+             * Template to use for the header, before the list of items.
+             */
+            header: Template<{
+                items: Array<{
+                    query: string;
+                }>;
+            }>;
             /**
              * Template to use for each result. This template will receive an object containing a single record.
              */
@@ -371,6 +379,7 @@ declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
                 onRemoveRecentSearch: () => void;
             }>;
         }>;
+        cssClasses?: Partial<AutocompleteIndexClassNames>;
     };
     /**
      * Search parameters to apply to the autocomplete indices.
@@ -8154,7 +8163,7 @@ declare type SortByConnector = Connector<SortByWidgetDescription, SortByConnecto
 
 declare type SortByConnectorParams = {
     /**
-     * Array of objects defining the different indices to choose from.
+     * Array of objects defining the different indices or strategies to choose from.
      */
     items: SortByItem[];
     /**
@@ -8163,6 +8172,8 @@ declare type SortByConnectorParams = {
     transformItems?: TransformItems<SortByItem>;
 };
 
+declare type SortByDefinition = SortByIndexDefinition | SortByStrategyDefinition;
+
 declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
 
 declare type SortByIndexDefinition = {
@@ -8174,14 +8185,27 @@ declare type SortByIndexDefinition = {
      * The label of the index to display.
      */
     label: string;
+    /**
+     * Ensures mutual exclusivity with strategy.
+     */
+    strategy?: never;
 };
 
 /**
  * The **SortBy** connector provides the logic to build a custom widget that will display a
- * list of indices. With Algolia, this is most commonly used for changing ranking strategy. This allows
- * a user to change how the hits are being sorted.
+ * list of indices or sorting strategies. With Algolia, this is most commonly used for changing
+ * ranking strategy. This allows a user to change how the hits are being sorted.
+ *
+ * This connector supports two sorting modes:
+ * 1. **Index-based (traditional)**: Uses the `value` property to switch between different indices.
+ *    This is the standard behavior for non-composition setups.
+ *
+ * 2. **Strategy-based (composition mode)**: Uses the `strategy` property to apply sorting strategies
+ *    via the `sortBy` search parameter. This is only available when using Algolia Compositions.
+ *
+ * Items can mix both types in the same widget, allowing for flexible sorting options.
  */
-declare type SortByItem = {
+declare type SortByIndexItem = {
     /**
      * The name of the index to target.
      */
@@ -8190,23 +8214,32 @@ declare type SortByItem = {
      * The label of the index to display.
      */
     label: string;
+    /**
+     * Ensures mutual exclusivity with strategy.
+     */
+    strategy?: never;
 };
 
+declare type SortByItem = SortByIndexItem | SortByStrategyItem;
+
 declare type SortByRenderState = {
     /**
-     * The initially selected index.
+     * The initially selected index or strategy.
      */
     initialIndex?: string;
     /**
-     * The currently selected index.
+     * The currently selected index or strategy.
      */
     currentRefinement: string;
     /**
-     * All the available indices
+     * All the available indices and strategies
      */
-    options: SortByItem[];
+    options: Array<{
+        value: string;
+        label: string;
+    }>;
     /**
-     * Switches indices and triggers a new search.
+     * Switches indices or strategies and triggers a new search.
      */
     refine: (value: string) => void;
     /**
@@ -8220,6 +8253,38 @@ declare type SortByRenderState = {
     canRefine: boolean;
 };
 
+declare type SortByStrategyDefinition = {
+    /**
+     * The name of the sorting strategy to use.
+     * Only available in composition mode.
+     */
+    strategy: string;
+    /**
+     * The label of the strategy to display.
+     */
+    label: string;
+    /**
+     * Ensures mutual exclusivity with value.
+     */
+    value?: never;
+};
+
+declare type SortByStrategyItem = {
+    /**
+     * The name of the sorting strategy to use.
+     * Only available in composition mode.
+     */
+    strategy: string;
+    /**
+     * The label of the strategy to display.
+     */
+    label: string;
+    /**
+     * Ensures mutual exclusivity with value.
+     */
+    value?: never;
+};
+
 declare type SortByWidget = WidgetFactory<SortByWidgetDescription & {
     $$widgetType: 'ais.sortBy';
 }, SortByConnectorParams, SortByWidgetParams>;
@@ -8256,9 +8321,9 @@ declare type SortByWidgetParams = {
      */
     container: string | HTMLElement;
     /**
-     * Array of objects defining the different indices to choose from.
+     * Array of objects defining the different indices or strategies to choose from.
      */
-    items: SortByIndexDefinition[];
+    items: SortByDefinition[];
     /**
      * CSS classes to be added.
      */