instantsearch.js 4.38.1 → 4.39.2

package/dist/instantsearch.production.d.ts

@@ -12,8 +12,7 @@ import { default as qs_2 } from 'qs';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
-declare type AlgoliaHit = {
-    [attribute: string]: any;
+declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
     objectID: string;
     _highlightResult?: HitHighlightResult;
     _snippetResult?: HitSnippetResult;
@@ -36,7 +35,7 @@ declare type AlgoliaHit = {
     };
     _distinctSeqID?: number;
     _geoLoc?: GeoLoc;
-};
+} & THit;
 
 declare const analytics: AnalyticsWidget;
 
@@ -292,6 +291,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type BaseHit = Record<string, unknown>;
+
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
 
 declare type Bounds = {
@@ -734,11 +735,11 @@ declare const connectHits: HitsConnector;
 
 declare const connectHitsPerPage: HitsPerPageConnector;
 
-declare const connectHitsWithInsights: HitsConnector;
+declare const connectHitsWithInsights: HitsConnector<BaseHit>;
 
 declare const connectInfiniteHits: InfiniteHitsConnector;
 
-declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector;
+declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector<BaseHit>;
 
 /**
  * **Menu** connector provides the logic to build a widget that will give the user the ability to choose a single value for a specific facet. The typical usage of menu is for navigation in categories.
@@ -1471,7 +1472,7 @@ 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.
      */
@@ -1760,10 +1761,10 @@ declare type HighlightOptions = {
 
 declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
-declare type Hit = {
+declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
     __queryID?: string;
-} & AlgoliaHit;
+} & AlgoliaHit<THit>;
 
 declare type HitAttributeHighlightResult = {
     value: string;
@@ -1778,13 +1779,16 @@ 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 = Connector<HitsWidgetDescription, HitsConnectorParams>;
+declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
 
-declare type HitsConnectorParams = {
+declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Whether to escape HTML tags from hits string values.
      *
@@ -1794,7 +1798,7 @@ declare type HitsConnectorParams = {
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
 };
 
 declare type HitsCSSClasses = Partial<{
@@ -1923,15 +1927,15 @@ declare type HitsPerPageWidgetParams = {
     cssClasses?: HitsPerPageCSSClasses;
 };
 
-declare type HitsRenderState = {
+declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -1963,11 +1967,11 @@ declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
     $$widgetType: 'ais.hits';
 }, HitsConnectorParams, HitsWidgetParams>;
 
-declare type HitsWidgetDescription = {
+declare type HitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.hits';
-    renderState: HitsRenderState;
+    renderState: HitsRenderState<THit>;
     indexRenderState: {
-        hits: WidgetRenderState<HitsRenderState, HitsConnectorParams>;
+        hits: WidgetRenderState<HitsRenderState<THit>, HitsConnectorParams<THit>>;
     };
 };
 
@@ -2048,18 +2052,18 @@ declare type IndexWidgetParams = {
 
 declare const infiniteHits: InfiniteHitsWidget;
 
-declare type InfiniteHitsCache = {
-    read: Read;
-    write: Write;
+declare type InfiniteHitsCache<THit extends BaseHit = BaseHit> = {
+    read: Read<THit>;
+    write: Write<THit>;
 };
 
-declare type InfiniteHitsCachedHits = {
-    [page: number]: Hits;
+declare type InfiniteHitsCachedHits<THit extends BaseHit> = {
+    [page: number]: Array<Hit<THit>>;
 };
 
-declare type InfiniteHitsConnector = Connector<InfiniteHitsWidgetDescription, InfiniteHitsConnectorParams>;
+declare type InfiniteHitsConnector<THit extends BaseHit = BaseHit> = Connector<InfiniteHitsWidgetDescription<THit>, InfiniteHitsConnectorParams<THit>>;
 
-declare type InfiniteHitsConnectorParams = {
+declare type InfiniteHitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Escapes HTML entities from hits string values.
      *
@@ -2076,13 +2080,13 @@ declare type InfiniteHitsConnectorParams = {
      * Receives the items, and is called before displaying them.
      * Useful for mapping over the items to transform, and remove or reorder them.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
     /**
      * Reads and writes hits from/to cache.
      * When user comes back to the search page after leaving for product page,
      * this helps restore InfiniteHits and its scroll position.
      */
-    cache?: InfiniteHitsCache;
+    cache?: InfiniteHitsCache<THit>;
 };
 
 declare type InfiniteHitsCSSClasses = Partial<{
@@ -2120,7 +2124,7 @@ declare type InfiniteHitsCSSClasses = Partial<{
     disabledLoadMore: string | string[];
 }>;
 
-declare type InfiniteHitsRenderState = {
+declare type InfiniteHitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * Loads the previous results.
      */
@@ -2148,15 +2152,15 @@ declare type InfiniteHitsRenderState = {
     /**
      * Hits for the current page
      */
-    currentPageHits: Hits;
+    currentPageHits: Array<Hit<THit>>;
     /**
      * Hits for current and cached pages
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
 };
 
 declare type InfiniteHitsTemplates = Partial<{
@@ -2186,11 +2190,11 @@ declare type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription &
     $$widgetType: 'ais.infiniteHits';
 }, InfiniteHitsConnectorParams, InfiniteHitsWidgetParams>;
 
-declare type InfiniteHitsWidgetDescription = {
+declare type InfiniteHitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.infiniteHits';
-    renderState: InfiniteHitsRenderState;
+    renderState: InfiniteHitsRenderState<THit>;
     indexRenderState: {
-        infiniteHits: WidgetRenderState<InfiniteHitsRenderState, InfiniteHitsConnectorParams>;
+        infiniteHits: WidgetRenderState<InfiniteHitsRenderState<THit>, InfiniteHitsConnectorParams<THit>>;
     };
     indexUiState: {
         page: number;
@@ -2529,7 +2533,7 @@ 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.
      */
@@ -3807,9 +3811,9 @@ declare type RatingMenuWidgetParams = {
     cssClasses?: RatingMenuCSSClasses;
 };
 
-declare type Read = ({ state, }: {
+declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
-}) => InfiniteHitsCachedHits | null;
+}) => InfiniteHitsCachedHits<THit> | null;
 
 declare type ReconfigurableOptions = Places.ReconfigurableOptions;
 
@@ -3873,7 +3877,7 @@ 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.
      */
@@ -4623,7 +4627,7 @@ declare type SnippetOptions = {
 /**
  * Transforms the given items.
  */
-declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<'count' | 'isRefined' | 'name:asc' | 'name:desc'>;
+declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<SortByDirection<'count' | 'name' | 'isRefined'>>;
 
 /**
  * Sort by selector is a widget used for letting the user choose between different
@@ -4644,6 +4648,8 @@ declare type SortByConnectorParams = {
     transformItems?: TransformItems<SortByItem>;
 };
 
+declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
+
 declare type SortByIndexDefinition = {
     /**
      * The name of the index to target.
@@ -5251,9 +5257,9 @@ declare type WidgetType<TWidgetDescription extends WidgetDescription> = TWidgetD
 
 declare type WidgetUiStates = PlacesWidgetDescription['indexUiState'];
 
-declare type Write = ({ state, hits, }: {
+declare type Write<THit extends BaseHit> = ({ state, hits, }: {
     state: PlainSearchParameters;
-    hits: InfiniteHitsCachedHits;
+    hits: InfiniteHitsCachedHits<THit>;
 }) => void;
 
 export { }

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

@@ -12,8 +12,7 @@ import { default as qs_2 } from 'qs';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
-declare type AlgoliaHit = {
-    [attribute: string]: any;
+declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
     objectID: string;
     _highlightResult?: HitHighlightResult;
     _snippetResult?: HitSnippetResult;
@@ -36,7 +35,7 @@ declare type AlgoliaHit = {
     };
     _distinctSeqID?: number;
     _geoLoc?: GeoLoc;
-};
+} & THit;
 
 declare const analytics: AnalyticsWidget;
 
@@ -292,6 +291,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type BaseHit = Record<string, unknown>;
+
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
 
 declare type Bounds = {
@@ -734,11 +735,11 @@ declare const connectHits: HitsConnector;
 
 declare const connectHitsPerPage: HitsPerPageConnector;
 
-declare const connectHitsWithInsights: HitsConnector;
+declare const connectHitsWithInsights: HitsConnector<BaseHit>;
 
 declare const connectInfiniteHits: InfiniteHitsConnector;
 
-declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector;
+declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector<BaseHit>;
 
 /**
  * **Menu** connector provides the logic to build a widget that will give the user the ability to choose a single value for a specific facet. The typical usage of menu is for navigation in categories.
@@ -1471,7 +1472,7 @@ 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.
      */
@@ -1760,10 +1761,10 @@ declare type HighlightOptions = {
 
 declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
-declare type Hit = {
+declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
     __queryID?: string;
-} & AlgoliaHit;
+} & AlgoliaHit<THit>;
 
 declare type HitAttributeHighlightResult = {
     value: string;
@@ -1778,13 +1779,16 @@ 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 = Connector<HitsWidgetDescription, HitsConnectorParams>;
+declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
 
-declare type HitsConnectorParams = {
+declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Whether to escape HTML tags from hits string values.
      *
@@ -1794,7 +1798,7 @@ declare type HitsConnectorParams = {
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
 };
 
 declare type HitsCSSClasses = Partial<{
@@ -1923,15 +1927,15 @@ declare type HitsPerPageWidgetParams = {
     cssClasses?: HitsPerPageCSSClasses;
 };
 
-declare type HitsRenderState = {
+declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -1963,11 +1967,11 @@ declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
     $$widgetType: 'ais.hits';
 }, HitsConnectorParams, HitsWidgetParams>;
 
-declare type HitsWidgetDescription = {
+declare type HitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.hits';
-    renderState: HitsRenderState;
+    renderState: HitsRenderState<THit>;
     indexRenderState: {
-        hits: WidgetRenderState<HitsRenderState, HitsConnectorParams>;
+        hits: WidgetRenderState<HitsRenderState<THit>, HitsConnectorParams<THit>>;
     };
 };
 
@@ -2048,18 +2052,18 @@ declare type IndexWidgetParams = {
 
 declare const infiniteHits: InfiniteHitsWidget;
 
-declare type InfiniteHitsCache = {
-    read: Read;
-    write: Write;
+declare type InfiniteHitsCache<THit extends BaseHit = BaseHit> = {
+    read: Read<THit>;
+    write: Write<THit>;
 };
 
-declare type InfiniteHitsCachedHits = {
-    [page: number]: Hits;
+declare type InfiniteHitsCachedHits<THit extends BaseHit> = {
+    [page: number]: Array<Hit<THit>>;
 };
 
-declare type InfiniteHitsConnector = Connector<InfiniteHitsWidgetDescription, InfiniteHitsConnectorParams>;
+declare type InfiniteHitsConnector<THit extends BaseHit = BaseHit> = Connector<InfiniteHitsWidgetDescription<THit>, InfiniteHitsConnectorParams<THit>>;
 
-declare type InfiniteHitsConnectorParams = {
+declare type InfiniteHitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Escapes HTML entities from hits string values.
      *
@@ -2076,13 +2080,13 @@ declare type InfiniteHitsConnectorParams = {
      * Receives the items, and is called before displaying them.
      * Useful for mapping over the items to transform, and remove or reorder them.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
     /**
      * Reads and writes hits from/to cache.
      * When user comes back to the search page after leaving for product page,
      * this helps restore InfiniteHits and its scroll position.
      */
-    cache?: InfiniteHitsCache;
+    cache?: InfiniteHitsCache<THit>;
 };
 
 declare type InfiniteHitsCSSClasses = Partial<{
@@ -2120,7 +2124,7 @@ declare type InfiniteHitsCSSClasses = Partial<{
     disabledLoadMore: string | string[];
 }>;
 
-declare type InfiniteHitsRenderState = {
+declare type InfiniteHitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * Loads the previous results.
      */
@@ -2148,15 +2152,15 @@ declare type InfiniteHitsRenderState = {
     /**
      * Hits for the current page
      */
-    currentPageHits: Hits;
+    currentPageHits: Array<Hit<THit>>;
     /**
      * Hits for current and cached pages
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
 };
 
 declare type InfiniteHitsTemplates = Partial<{
@@ -2186,11 +2190,11 @@ declare type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription &
     $$widgetType: 'ais.infiniteHits';
 }, InfiniteHitsConnectorParams, InfiniteHitsWidgetParams>;
 
-declare type InfiniteHitsWidgetDescription = {
+declare type InfiniteHitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.infiniteHits';
-    renderState: InfiniteHitsRenderState;
+    renderState: InfiniteHitsRenderState<THit>;
     indexRenderState: {
-        infiniteHits: WidgetRenderState<InfiniteHitsRenderState, InfiniteHitsConnectorParams>;
+        infiniteHits: WidgetRenderState<InfiniteHitsRenderState<THit>, InfiniteHitsConnectorParams<THit>>;
     };
     indexUiState: {
         page: number;
@@ -2529,7 +2533,7 @@ 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.
      */
@@ -3807,9 +3811,9 @@ declare type RatingMenuWidgetParams = {
     cssClasses?: RatingMenuCSSClasses;
 };
 
-declare type Read = ({ state, }: {
+declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
-}) => InfiniteHitsCachedHits | null;
+}) => InfiniteHitsCachedHits<THit> | null;
 
 declare type ReconfigurableOptions = Places.ReconfigurableOptions;
 
@@ -3873,7 +3877,7 @@ 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.
      */
@@ -4623,7 +4627,7 @@ declare type SnippetOptions = {
 /**
  * Transforms the given items.
  */
-declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<'count' | 'isRefined' | 'name:asc' | 'name:desc'>;
+declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<SortByDirection<'count' | 'name' | 'isRefined'>>;
 
 /**
  * Sort by selector is a widget used for letting the user choose between different
@@ -4644,6 +4648,8 @@ declare type SortByConnectorParams = {
     transformItems?: TransformItems<SortByItem>;
 };
 
+declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
+
 declare type SortByIndexDefinition = {
     /**
      * The name of the index to target.
@@ -5251,9 +5257,9 @@ declare type WidgetType<TWidgetDescription extends WidgetDescription> = TWidgetD
 
 declare type WidgetUiStates = PlacesWidgetDescription['indexUiState'];
 
-declare type Write = ({ state, hits, }: {
+declare type Write<THit extends BaseHit> = ({ state, hits, }: {
     state: PlainSearchParameters;
-    hits: InfiniteHitsCachedHits;
+    hits: InfiniteHitsCachedHits<THit>;
 }) => void;
 
 export { }