instantsearch.js 4.38.1 → 4.39.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# [4.39.0](https://github.com/algolia/instantsearch.js/compare/v4.38.1...v4.39.0) (2022-02-23)
+
+
+### Features
+
+* **ts:** allow Hits related connectors to be generic ([#5019](https://github.com/algolia/instantsearch.js/issues/5019)) ([e986f7e](https://github.com/algolia/instantsearch.js/commit/e986f7e46d57173da4d3d6c3c23fbdf3f9c0f78c))
+
+
+
 ## [4.38.1](https://github.com/algolia/instantsearch.js/compare/v4.38.0...v4.38.1) (2022-02-08)
 
 

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -69,7 +69,8 @@ function extractHitsFromCachedHits(cachedHits) {
 
 var connectInfiniteHits = function connectInfiniteHits(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _index.noop;
-  (0, _index.checkRendering)(renderFn, withUsage());
+  (0, _index.checkRendering)(renderFn, withUsage()); // @TODO: this should be a generic, but a Connector can not yet be generic itself
+
   return function (widgetParams) {
     var _ref4 = widgetParams || {},
         _ref4$escapeHTML = _ref4.escapeHTML,

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.38.1';
+var _default = '4.39.0';
 exports.default = _default;

package/dist/instantsearch.development.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.
@@ -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;
@@ -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;
 
@@ -5251,9 +5255,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.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.38.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.39.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -8483,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.38.1';
+  var version$1 = '4.39.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -11547,7 +11547,8 @@
 
   var connectInfiniteHits = function connectInfiniteHits(renderFn) {
     var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
-    checkRendering(renderFn, withUsage$7());
+    checkRendering(renderFn, withUsage$7()); // @TODO: this should be a generic, but a Connector can not yet be generic itself
+
     return function (widgetParams) {
       var _ref4 = widgetParams || {},
           _ref4$escapeHTML = _ref4.escapeHTML,