instantsearch.js 4.71.1 → 4.72.0

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

@@ -1,7 +1,6 @@
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
 import type { TransformItems, Connector, Hit, WidgetRenderState, BaseHit, Unmounter, Renderer, IndexRenderState } from '../../types';
-import type { SearchResults } from 'algoliasearch-helper';
-type Banner = NonNullable<NonNullable<Required<SearchResults<Hit>['renderingContent']>>['widgets']['banners']>[number];
+import type { Banner, SearchResults } from 'algoliasearch-helper';
 export type HitsRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
      * The matched hits from Algolia API.
@@ -110,18 +109,7 @@ declare const _default: <TWidgetParams>(renderFn: Renderer<HitsRenderState<BaseH
         hits: Hit<BaseHit>[] | Hit<THit>[];
         items: Hit<BaseHit>[] | Hit<THit>[];
         results: SearchResults<any>;
-        banner: {
-            image: {
-                urls: {
-                    url: string;
-                }[];
-                title?: string | undefined;
-            };
-            link?: {
-                url: string;
-                target?: "_blank" | "_self" | undefined;
-            } | undefined;
-        } | undefined;
+        banner: Banner | undefined;
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
         widgetParams: TWidgetParams & HitsConnectorParams<THit>;

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

@@ -132,18 +132,7 @@ declare const connectHitsWithInsights: <TWidgetParams>(renderFn: import("../../t
         hits: import("../../types").Hit<import("../../types").BaseHit>[] | import("../../types").Hit<THit>[];
         items: import("../../types").Hit<import("../../types").BaseHit>[] | import("../../types").Hit<THit>[];
         results: import("algoliasearch-helper").SearchResults<any>;
-        banner: {
-            image: {
-                urls: {
-                    url: string;
-                }[];
-                title?: string | undefined;
-            };
-            link?: {
-                url: string;
-                target?: "_blank" | "_self" | undefined;
-            } | undefined;
-        } | undefined;
+        banner: import("algoliasearch-helper").Banner | undefined;
         sendEvent: import("../../lib/utils").SendEventForHits;
         bindEvent: import("../../lib/utils").BindEventForHits;
         widgetParams: TWidgetParams & HitsConnectorParams<THit>;

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

@@ -1,6 +1,6 @@
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
 import type { Connector, TransformItems, Hit, WidgetRenderState, BaseHit, Renderer, Unmounter, IndexRenderState } from '../../types';
-import type { AlgoliaSearchHelper as Helper, PlainSearchParameters, SearchParameters, SearchResults } from 'algoliasearch-helper';
+import type { Banner, AlgoliaSearchHelper as Helper, PlainSearchParameters, SearchParameters, SearchResults } from 'algoliasearch-helper';
 export type InfiniteHitsCachedHits<THit extends NonNullable<object>> = {
     [page: number]: Array<Hit<THit>>;
 };
@@ -82,6 +82,10 @@ export type InfiniteHitsRenderState<THit extends NonNullable<object> = BaseHit>
      * The response from the Algolia API.
      */
     results?: SearchResults<Hit<THit>>;
+    /**
+     * The banner to display above the hits.
+     */
+    banner?: Banner;
 };
 export type InfiniteHitsWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
     $$type: 'ais.infiniteHits';
@@ -149,6 +153,7 @@ declare const _default: <TWidgetParams extends object>(renderFn: Renderer<Infini
         currentPageHits: Hit<THit>[];
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
+        banner: Banner | undefined;
         results: SearchResults<any> | undefined;
         showPrevious: () => void;
         showMore: () => void;

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

@@ -133,6 +133,7 @@ export default (function connectInfiniteHits(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(_ref6) {
+        var _results$renderingCon, _results$renderingCon2, _results$renderingCon3;
         var results = _ref6.results,
           helper = _ref6.helper,
           parent = _ref6.parent,
@@ -149,6 +150,7 @@ export default (function connectInfiniteHits(renderFn) {
         var cachedHits = cache.read({
           state: normalizeState(state)
         }) || {};
+        var banner = results === null || results === void 0 ? void 0 : (_results$renderingCon = results.renderingContent) === null || _results$renderingCon === void 0 ? void 0 : (_results$renderingCon2 = _results$renderingCon.widgets) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.banners) === null || _results$renderingCon3 === void 0 ? void 0 : _results$renderingCon3[0];
         if (!results) {
           showPrevious = getShowPrevious(helper);
           showMore = getShowMore(helper);
@@ -213,6 +215,7 @@ export default (function connectInfiniteHits(renderFn) {
           currentPageHits: currentPageHits,
           sendEvent: sendEvent,
           bindEvent: bindEvent,
+          banner: banner,
           results: results,
           showPrevious: showPrevious,
           showMore: showMore,

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

@@ -126,6 +126,7 @@ declare const connectInfiniteHitsWithInsights: <TWidgetParams extends object>(re
         currentPageHits: import("../../types").Hit<THit>[];
         sendEvent: import("../../lib/utils").SendEventForHits;
         bindEvent: import("../../lib/utils").BindEventForHits;
+        banner: import("algoliasearch-helper").Banner | undefined;
         results: import("algoliasearch-helper").SearchResults<any> | undefined;
         showPrevious: () => void;
         showMore: () => void;

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.71.1";
+declare const _default: "4.72.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.71.1';
+export default '4.72.0';

package/es/middlewares/createRouterMiddleware.js

@@ -6,7 +6,7 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 import historyRouter from "../lib/routers/history.js";
 import simpleStateMapping from "../lib/stateMappings/simple.js";
-import { isEqual } from "../lib/utils/index.js";
+import { isEqual, warning } from "../lib/utils/index.js";
 export var createRouterMiddleware = function createRouterMiddleware() {
   var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   var _props$router = props.router,
@@ -50,6 +50,7 @@ export var createRouterMiddleware = function createRouterMiddleware() {
         }
       },
       subscribe: function subscribe() {
+        process.env.NODE_ENV === 'development' ? warning(Object.keys(initialUiState).length === 0, 'Using `initialUiState` together with routing is not recommended. The `initialUiState` will be overwritten by the URL parameters.') : void 0;
         instantSearchInstance._initialUiState = _objectSpread(_objectSpread({}, initialUiState), stateMapping.routeToState(router.read()));
         router.onUpdate(function (route) {
           if (instantSearchInstance.mainIndex.getWidgets().length > 0) {

package/es/widgets/hits/hits.d.ts

@@ -170,11 +170,7 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: HitsWidget
     getWidgetRenderState({ results, helper, instantSearchInstance }: import("../../types").InitOptions | import("../../types").RenderOptions): {
         hits: never[];
         items: never[];
-        results: undefined; /**
-         * Template to use for each result. This template will receive an object containing a single record.
-         *
-         * @default ''
-         */
+        results: undefined;
         banner: undefined;
         sendEvent: import("../../lib/utils").SendEventForHits;
         bindEvent: import("../../lib/utils").BindEventForHits;
@@ -183,22 +179,11 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: HitsWidget
         hits: Hit<BaseHit>[] | Hit<THit>[];
         items: Hit<BaseHit>[] | Hit<THit>[];
         results: SearchResults<any>;
+        banner: import("algoliasearch-helper").Banner | undefined;
+        sendEvent: import("../../lib/utils").SendEventForHits;
         /**
-         * CSS classes to add.
+         * Templates to use for the widget.
          */
-        banner: {
-            image: {
-                urls: {
-                    url: string;
-                }[];
-                title?: string | undefined;
-            };
-            link?: {
-                url: string;
-                target?: "_blank" | "_self" | undefined;
-            } | undefined;
-        } | undefined;
-        sendEvent: import("../../lib/utils").SendEventForHits;
         bindEvent: import("../../lib/utils").BindEventForHits;
         widgetParams: Partial<HitsWidgetParams<BaseHit>> & HitsConnectorParams<THit>;
     };

package/es/widgets/infinite-hits/infinite-hits.d.ts

@@ -213,6 +213,7 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: InfiniteHi
         currentPageHits: Hit<THit>[];
         sendEvent: import("../../lib/utils").SendEventForHits;
         bindEvent: import("../../lib/utils").BindEventForHits;
+        banner: import("algoliasearch-helper").Banner | undefined;
         results: SearchResults<any> | undefined;
         showPrevious: () => void;
         showMore: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.71.1",
+  "version": "4.72.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",
@@ -31,10 +31,10 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "3.21.0",
+    "algoliasearch-helper": "3.22.0",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
-    "instantsearch-ui-components": "0.6.0",
+    "instantsearch-ui-components": "0.7.0",
     "preact": "^10.10.0",
     "qs": "^6.5.1 < 6.10",
     "search-insights": "^2.13.0"
@@ -56,9 +56,9 @@
     "watch:es": "yarn --silent build:es:base --watch"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.47.0",
-    "@instantsearch/tests": "1.47.0",
-    "@instantsearch/testutils": "1.36.0",
+    "@instantsearch/mocks": "1.48.0",
+    "@instantsearch/tests": "1.48.0",
+    "@instantsearch/testutils": "1.37.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.23.2",
@@ -66,5 +66,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "443c2f875bd5ddd5cc94285b49c1e8c05df5e0f6"
+  "gitHead": "0b125d8a3fb2a5905aea9b6b540e07ab91649215"
 }