instantsearch.js 4.39.1 → 4.39.2

package/es/connectors/hierarchical-menu/connectHierarchicalMenu.d.ts

@@ -1,4 +1,5 @@
 import type { SendEventForFacet } from '../../lib/utils';
+import type { SearchResults } from 'algoliasearch-helper';
 import type { Connector, CreateURL, TransformItems, SortBy, WidgetRenderState } from '../../types';
 export declare type HierarchicalMenuItem = {
     /**
@@ -58,7 +59,7 @@ export declare type HierarchicalMenuConnectorParams = {
      *
      * If a facetOrdering is set in the index settings, it is used when sortBy isn't passed
      */
-    sortBy?: SortBy<HierarchicalMenuItem>;
+    sortBy?: SortBy<SearchResults.HierarchicalFacet>;
     /**
      * Function to transform the items passed to the templates.
      */

package/es/connectors/menu/connectMenu.d.ts

@@ -1,3 +1,4 @@
+import type { SearchResults } from 'algoliasearch-helper';
 import type { SendEventForFacet } from '../../lib/utils';
 import type { Connector, CreateURL, SortBy, TransformItems, WidgetRenderState } from '../../types';
 export declare type MenuItem = {
@@ -42,7 +43,7 @@ export declare type MenuConnectorParams = {
      *
      * If a facetOrdering is set in the index settings, it is used when sortBy isn't passed
      */
-    sortBy?: SortBy<MenuItem>;
+    sortBy?: SortBy<SearchResults.HierarchicalFacet>;
     /**
      * Function to transform the items passed to the templates.
      */

package/es/connectors/refinement-list/connectRefinementList.d.ts

@@ -1,3 +1,4 @@
+import type { SearchResults } from 'algoliasearch-helper';
 import type { SendEventForFacet } from '../../lib/utils';
 import type { Connector, TransformItems, SortBy, CreateURL, WidgetRenderState } from '../../types';
 export declare type RefinementListItem = {
@@ -52,7 +53,7 @@ export declare type RefinementListConnectorParams = {
      *
      * If a facetOrdering is set in the index settings, it is used when sortBy isn't passed
      */
-    sortBy?: SortBy<RefinementListItem>;
+    sortBy?: SortBy<SearchResults.FacetValue>;
     /**
      * Escapes the content of the facet values.
      */

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.39.1";
+declare const _default: "4.39.2";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.39.1';
+export default '4.39.2';

package/es/types/widget.d.ts

@@ -136,10 +136,11 @@ export declare type TransformItemsMetadata = {
  * Transforms the given items.
  */
 export declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
+declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
 /**
  * Transforms the given items.
  */
-export declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<'count' | 'isRefined' | 'name:asc' | 'name:desc'>;
+export declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<SortByDirection<'count' | 'name' | 'isRefined'>>;
 /**
  * Creates the URL for the given value.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.39.1",
+  "version": "4.39.2",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",