instantsearch.js 4.38.1 → 4.39.2

package/es/components/ToggleRefinement/ToggleRefinement.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-environment jsdom
+ */
 /** @jsx h */
 import { h } from 'preact';
 import type { ToggleRefinementRenderState, ToggleRefinementValue } from '../../connectors/toggle-refinement/connectToggleRefinement';

package/es/components/ToggleRefinement/ToggleRefinement.js

@@ -1,5 +1,9 @@
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
+/**
+ * @jest-environment jsdom
+ */
+
 /** @jsx h */
 import { h } from 'preact';
 import Template from "../Template/Template.js";

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/hits/connectHits.d.ts

@@ -1,15 +1,15 @@
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
-import type { TransformItems, Connector, Hits, Hit, WidgetRenderState } from '../../types';
+import type { TransformItems, Connector, Hit, WidgetRenderState, BaseHit } from '../../types';
 import type { SearchResults } from 'algoliasearch-helper';
-export declare type HitsRenderState = {
+export 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.
      */
@@ -19,7 +19,7 @@ export declare type HitsRenderState = {
      */
     bindEvent: BindEventForHits;
 };
-export declare type HitsConnectorParams = {
+export declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Whether to escape HTML tags from hits string values.
      *
@@ -29,15 +29,15 @@ export declare type HitsConnectorParams = {
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
 };
-export declare type HitsWidgetDescription = {
+export 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>>;
     };
 };
-export declare type HitsConnector = Connector<HitsWidgetDescription, HitsConnectorParams>;
+export declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
 declare const connectHits: HitsConnector;
 export default connectHits;

package/es/connectors/hits/connectHits.js

@@ -33,10 +33,10 @@ var connectHits = function connectHits(renderFn) {
       },
       render: function render(renderOptions) {
         var renderState = this.getWidgetRenderState(renderOptions);
-        renderState.sendEvent('view', renderState.hits);
         renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
           instantSearchInstance: renderOptions.instantSearchInstance
         }), false);
+        renderState.sendEvent('view', renderState.hits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

package/es/connectors/hits/connectHitsWithInsights.d.ts

@@ -1,2 +1,2 @@
-declare const connectHitsWithInsights: import("./connectHits").HitsConnector;
+declare const connectHitsWithInsights: import("./connectHits").HitsConnector<import("../../types").BaseHit>;
 export default connectHitsWithInsights;

package/es/connectors/infinite-hits/connectInfiniteHits.d.ts

@@ -1,21 +1,21 @@
 import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
-import type { Hits, Connector, TransformItems, Hit, WidgetRenderState } from '../../types';
+import type { Connector, TransformItems, Hit, WidgetRenderState, BaseHit } from '../../types';
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
-export declare type InfiniteHitsCachedHits = {
-    [page: number]: Hits;
+export declare type InfiniteHitsCachedHits<THit extends BaseHit> = {
+    [page: number]: Array<Hit<THit>>;
 };
-declare type Read = ({ state, }: {
+declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
-}) => InfiniteHitsCachedHits | null;
-declare type Write = ({ state, hits, }: {
+}) => InfiniteHitsCachedHits<THit> | null;
+declare type Write<THit extends BaseHit> = ({ state, hits, }: {
     state: PlainSearchParameters;
-    hits: InfiniteHitsCachedHits;
+    hits: InfiniteHitsCachedHits<THit>;
 }) => void;
-export declare type InfiniteHitsCache = {
-    read: Read;
-    write: Write;
+export declare type InfiniteHitsCache<THit extends BaseHit = BaseHit> = {
+    read: Read<THit>;
+    write: Write<THit>;
 };
-export declare type InfiniteHitsConnectorParams = {
+export declare type InfiniteHitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Escapes HTML entities from hits string values.
      *
@@ -32,15 +32,15 @@ export 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>;
 };
-export declare type InfiniteHitsRenderState = {
+export declare type InfiniteHitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * Loads the previous results.
      */
@@ -68,26 +68,26 @@ export 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>>;
 };
-export declare type InfiniteHitsWidgetDescription = {
+export 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;
     };
 };
-export declare type InfiniteHitsConnector = Connector<InfiniteHitsWidgetDescription, InfiniteHitsConnectorParams>;
+export declare type InfiniteHitsConnector<THit extends BaseHit = BaseHit> = Connector<InfiniteHitsWidgetDescription<THit>, InfiniteHitsConnectorParams<THit>>;
 declare const connectInfiniteHits: InfiniteHitsConnector;
 export default connectInfiniteHits;

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

@@ -61,7 +61,8 @@ function extractHitsFromCachedHits(cachedHits) {
 
 var connectInfiniteHits = function connectInfiniteHits(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
-  checkRendering(renderFn, withUsage());
+  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,
@@ -132,10 +133,10 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
       render: function render(renderOptions) {
         var instantSearchInstance = renderOptions.instantSearchInstance;
         var widgetRenderState = this.getWidgetRenderState(renderOptions);
-        sendEvent('view', widgetRenderState.currentPageHits);
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), false);
+        sendEvent('view', widgetRenderState.currentPageHits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

package/es/connectors/infinite-hits/connectInfiniteHitsWithInsights.d.ts

@@ -1,2 +1,2 @@
-declare const connectInfiniteHitsWithInsights: import("./connectInfiniteHits").InfiniteHitsConnector;
+declare const connectInfiniteHitsWithInsights: import("./connectInfiniteHits").InfiniteHitsConnector<import("../../types").BaseHit>;
 export default connectInfiniteHitsWithInsights;

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/utils/createSendEventForHits.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-environment jsdom
+ */
 import type { InstantSearch, Hit, Hits } from '../../types';
 declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => void;
 declare type CustomSendEventForHits = (customPayload: any) => void;

package/es/lib/utils/createSendEventForHits.js

@@ -1,5 +1,8 @@
 function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
+/**
+ * @jest-environment jsdom
+ */
 import { serializePayload } from "./serializer.js";
 
 function chunk(arr) {

package/es/lib/version.d.ts

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

package/es/lib/version.js

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

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

@@ -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.38.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",
@@ -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",