instantsearch.js 4.37.3 → 4.39.0

package/es/types/results.d.ts

@@ -16,8 +16,7 @@ export declare type GeoLoc = {
     lat: number;
     lng: number;
 };
-export declare type AlgoliaHit = {
-    [attribute: string]: any;
+export declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
     objectID: string;
     _highlightResult?: HitHighlightResult;
     _snippetResult?: HitSnippetResult;
@@ -40,11 +39,15 @@ export declare type AlgoliaHit = {
     };
     _distinctSeqID?: number;
     _geoLoc?: GeoLoc;
-};
-export declare type Hit = {
+} & THit;
+export declare type BaseHit = Record<string, unknown>;
+export declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
     __queryID?: string;
-} & AlgoliaHit;
+} & AlgoliaHit<THit>;
+/**
+ * @deprecated use Hit[] directly instead
+ */
 export declare type Hits = Hit[];
 export declare type EscapedHits<THit = Hit> = THit[] & {
     __escaped: boolean;

package/es/types/widget.d.ts

@@ -129,10 +129,13 @@ declare type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription &
 export declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
+export declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 /**
  * Transforms the given items.
  */
-export declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+export declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
 /**
  * Transforms the given items.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.37.3",
+  "version": "4.39.0",
   "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",
@@ -39,8 +39,8 @@
     "test": "jest",
     "test:watch": "jest --watch --bail",
     "test:e2e": "yarn test:e2e:local",
-    "test:e2e:local": "wdio wdio.local.conf.js",
-    "test:e2e:saucelabs": "wdio wdio.saucelabs.conf.js",
+    "test:e2e:local": "wdio scripts/wdio/local.conf.js",
+    "test:e2e:saucelabs": "wdio scripts/wdio/saucelabs.conf.js",
     "test:size": "bundlesize",
     "test:argos": "argos upload functional-tests/screenshots --token $ARGOS_TOKEN || true",
     "test:exports": "node test/module/is-es-module.mjs",
@@ -120,7 +120,7 @@
     "eslint-plugin-prettier": "3.4.0",
     "eslint-plugin-react": "7.18.0",
     "eslint-plugin-react-hooks": "2.3.0",
-    "instantsearch-e2e-tests": "algolia/instantsearch-e2e-tests#1.3.0",
+    "instantsearch-e2e-tests": "algolia/instantsearch-e2e-tests#2.0.2",
     "jest": "27.1.0",
     "jest-diff": "27.1.0",
     "jest-environment-jsdom": "27.1.0",