instantsearch.js 4.73.4 → 4.74.1

package/es/widgets/index.js

@@ -1,10 +1,14 @@
 import { deprecate } from "../lib/utils/index.js";
 import answers from "./answers/answers.js";
+import configureRelatedItems from "./configure-related-items/configure-related-items.js";
 import dynamicWidgets from "./dynamic-widgets/dynamic-widgets.js";
 
 /** @deprecated answers is no longer supported */
 export var EXPERIMENTAL_answers = deprecate(answers, 'answers is no longer supported');
 
+/** @deprecated use relatedItems instead */
+export var EXPERIMENTAL_configureRelatedItems = deprecate(configureRelatedItems, 'EXPERIMENTAL_configureRelatedItems is deprecated and will be removed in a next minor version of InstantSearch. Please use relatedItems instead.');
+
 /** @deprecated use dynamicWidgets */
 export var EXPERIMENTAL_dynamicWidgets = deprecate(dynamicWidgets, 'use dynamicWidgets');
 export { dynamicWidgets };
@@ -13,7 +17,6 @@ export { default as breadcrumb } from "./breadcrumb/breadcrumb.js";
 export { default as clearRefinements } from "./clear-refinements/clear-refinements.js";
 export { default as configure } from "./configure/configure.js";
 export { default as currentRefinements } from "./current-refinements/current-refinements.js";
-export { default as EXPERIMENTAL_configureRelatedItems } from "./configure-related-items/configure-related-items.js";
 export { default as geoSearch } from "./geo-search/geo-search.js";
 export { default as hierarchicalMenu } from "./hierarchical-menu/hierarchical-menu.js";
 export { default as hits } from "./hits/hits.js";

package/es/widgets/looking-similar/looking-similar.d.ts

@@ -1,24 +1,32 @@
 
 import type { LookingSimilarWidgetDescription, LookingSimilarConnectorParams } from '../../connectors/looking-similar/connectLookingSimilar';
-import type { Template, WidgetFactory, Hit, BaseHit } from '../../types';
-import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { Template, WidgetFactory, AlgoliaHit, BaseHit, RecommendResponse } from '../../types';
 import type { RecommendClassNames, LookingSimilarProps as LookingSimilarUiProps } from 'instantsearch-ui-components';
 export type LookingSimilarCSSClasses = Partial<RecommendClassNames>;
 export type LookingSimilarTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
     /**
      * Template to use when there are no results.
      */
-    empty: Template<RecommendResultItem<Hit<THit>>>;
+    empty: Template<RecommendResponse<AlgoliaHit<THit>>>;
     /**
      * Template to use for the header of the widget.
      */
-    header: Template<Pick<Parameters<NonNullable<LookingSimilarUiProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<LookingSimilarUiProps<AlgoliaHit<THit>>['headerComponent']>>[0], 'items'> & {
         cssClasses: RecommendClassNames;
     }>;
     /**
      * Template to use for each result. This template will receive an object containing a single record.
      */
-    item: Template<Hit<THit>>;
+    item: Template<AlgoliaHit<THit>>;
+    /**
+     * Template to use to wrap all items.
+     */
+    layout: Template<Pick<Parameters<NonNullable<LookingSimilarUiProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: LookingSimilarUiProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<LookingSimilarCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 type LookingSimilarWidgetParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -217,9 +225,9 @@ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParam
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: Partial<LookingSimilarWidgetParams<BaseHit>> & LookingSimilarConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

package/es/widgets/looking-similar/looking-similar.js

@@ -60,6 +60,29 @@ function createRenderer(_ref) {
         data: results
       }));
     } : undefined;
+    var layoutComponent = templates.layout ? function (data) {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "layout",
+        rootTagName: "fragment",
+        data: {
+          items: data.items,
+          templates: {
+            item: templates.item ? function (_ref4) {
+              var item = _ref4.item;
+              return h(TemplateComponent, _extends({}, renderState.templateProps, {
+                templateKey: "item",
+                rootTagName: "fragment",
+                data: item
+              }));
+            } : undefined
+          },
+          cssClasses: {
+            list: data.classNames.list,
+            item: data.classNames.item
+          }
+        }
+      }));
+    } : undefined;
     render(h(LookingSimilar, {
       items: items,
       headerComponent: headerComponent,
@@ -67,24 +90,25 @@ function createRenderer(_ref) {
       sendEvent: function sendEvent() {},
       classNames: cssClasses,
       emptyComponent: emptyComponent,
+      layout: layoutComponent,
       status: instantSearchInstance.status
     }), containerNode);
   };
 }
 export default (function lookingSimilar(widgetParams) {
-  var _ref4 = widgetParams || {},
-    container = _ref4.container,
-    objectIDs = _ref4.objectIDs,
-    limit = _ref4.limit,
-    queryParameters = _ref4.queryParameters,
-    fallbackParameters = _ref4.fallbackParameters,
-    threshold = _ref4.threshold,
-    escapeHTML = _ref4.escapeHTML,
-    transformItems = _ref4.transformItems,
-    _ref4$templates = _ref4.templates,
-    templates = _ref4$templates === void 0 ? {} : _ref4$templates,
-    _ref4$cssClasses = _ref4.cssClasses,
-    cssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses;
+  var _ref5 = widgetParams || {},
+    container = _ref5.container,
+    objectIDs = _ref5.objectIDs,
+    limit = _ref5.limit,
+    queryParameters = _ref5.queryParameters,
+    fallbackParameters = _ref5.fallbackParameters,
+    threshold = _ref5.threshold,
+    escapeHTML = _ref5.escapeHTML,
+    transformItems = _ref5.transformItems,
+    _ref5$templates = _ref5.templates,
+    templates = _ref5$templates === void 0 ? {} : _ref5$templates,
+    _ref5$cssClasses = _ref5.cssClasses,
+    cssClasses = _ref5$cssClasses === void 0 ? {} : _ref5$cssClasses;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }

package/es/widgets/related-products/related-products.d.ts

@@ -1,24 +1,32 @@
 
 import type { RelatedProductsWidgetDescription, RelatedProductsConnectorParams } from '../../connectors/related-products/connectRelatedProducts';
-import type { Template, WidgetFactory, Hit, BaseHit } from '../../types';
-import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { Template, WidgetFactory, AlgoliaHit, BaseHit, RecommendResponse } from '../../types';
 import type { RecommendClassNames, RelatedProductsProps as RelatedProductsUiProps } from 'instantsearch-ui-components';
 export type RelatedProductsCSSClasses = Partial<RecommendClassNames>;
 export type RelatedProductsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
     /**
      * Template to use when there are no results.
      */
-    empty: Template<RecommendResultItem<Hit<THit>>>;
+    empty: Template<RecommendResponse<AlgoliaHit<THit>>>;
     /**
      * Template to use for the header of the widget.
      */
-    header: Template<Pick<Parameters<NonNullable<RelatedProductsUiProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<RelatedProductsUiProps<AlgoliaHit<THit>>['headerComponent']>>[0], 'items'> & {
         cssClasses: RecommendClassNames;
     }>;
     /**
      * Template to use for each result. This template will receive an object containing a single record.
      */
-    item: Template<Hit<THit>>;
+    item: Template<AlgoliaHit<THit>>;
+    /**
+     * Template to use to wrap all items.
+     */
+    layout: Template<Pick<Parameters<NonNullable<RelatedProductsUiProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: RelatedProductsUiProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<RelatedProductsCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 type RelatedProductsWidgetParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -217,9 +225,9 @@ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParam
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<BaseHit>[] | Hit<THit>[];
+        items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
         widgetParams: Partial<RelatedProductsWidgetParams<BaseHit>> & RelatedProductsConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

package/es/widgets/related-products/related-products.js

@@ -60,6 +60,29 @@ function createRenderer(_ref) {
         data: results
       }));
     } : undefined;
+    var layoutComponent = templates.layout ? function (data) {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "layout",
+        rootTagName: "fragment",
+        data: {
+          items: data.items,
+          templates: {
+            item: templates.item ? function (_ref4) {
+              var item = _ref4.item;
+              return h(TemplateComponent, _extends({}, renderState.templateProps, {
+                templateKey: "item",
+                rootTagName: "fragment",
+                data: item
+              }));
+            } : undefined
+          },
+          cssClasses: {
+            list: data.classNames.list,
+            item: data.classNames.item
+          }
+        }
+      }));
+    } : undefined;
     render(h(RelatedProducts, {
       items: items,
       sendEvent: function sendEvent() {},
@@ -67,24 +90,25 @@ function createRenderer(_ref) {
       headerComponent: headerComponent,
       itemComponent: itemComponent,
       emptyComponent: emptyComponent,
+      layout: layoutComponent,
       status: instantSearchInstance.status
     }), containerNode);
   };
 }
 export default (function relatedProducts(widgetParams) {
-  var _ref4 = widgetParams || {},
-    container = _ref4.container,
-    objectIDs = _ref4.objectIDs,
-    limit = _ref4.limit,
-    queryParameters = _ref4.queryParameters,
-    fallbackParameters = _ref4.fallbackParameters,
-    threshold = _ref4.threshold,
-    escapeHTML = _ref4.escapeHTML,
-    transformItems = _ref4.transformItems,
-    _ref4$templates = _ref4.templates,
-    templates = _ref4$templates === void 0 ? {} : _ref4$templates,
-    _ref4$cssClasses = _ref4.cssClasses,
-    cssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses;
+  var _ref5 = widgetParams || {},
+    container = _ref5.container,
+    objectIDs = _ref5.objectIDs,
+    limit = _ref5.limit,
+    queryParameters = _ref5.queryParameters,
+    fallbackParameters = _ref5.fallbackParameters,
+    threshold = _ref5.threshold,
+    escapeHTML = _ref5.escapeHTML,
+    transformItems = _ref5.transformItems,
+    _ref5$templates = _ref5.templates,
+    templates = _ref5$templates === void 0 ? {} : _ref5$templates,
+    _ref5$cssClasses = _ref5.cssClasses,
+    cssClasses = _ref5$cssClasses === void 0 ? {} : _ref5$cssClasses;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }

package/es/widgets/trending-items/trending-items.d.ts

@@ -1,24 +1,32 @@
 
 import type { TrendingItemsWidgetDescription, TrendingItemsConnectorParams } from '../../connectors/trending-items/connectTrendingItems';
-import type { Template, WidgetFactory, Hit, BaseHit } from '../../types';
-import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { Template, WidgetFactory, AlgoliaHit, BaseHit, RecommendResponse } from '../../types';
 import type { RecommendClassNames, TrendingItemsProps as TrendingItemsUiProps } from 'instantsearch-ui-components';
 export type TrendingItemsCSSClasses = Partial<RecommendClassNames>;
 export type TrendingItemsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
     /**
      * Template to use when there are no results.
      */
-    empty: Template<RecommendResultItem<Hit<THit>>>;
+    empty: Template<RecommendResponse<AlgoliaHit<THit>>>;
     /**
      * Template to use for the header of the widget.
      */
-    header: Template<Pick<Parameters<NonNullable<TrendingItemsUiProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<TrendingItemsUiProps<AlgoliaHit<THit>>['headerComponent']>>[0], 'items'> & {
         cssClasses: RecommendClassNames;
     }>;
     /**
      * Template to use for each result. This template will receive an object containing a single record.
      */
-    item: Template<Hit<THit>>;
+    item: Template<AlgoliaHit<THit>>;
+    /**
+     * Template to use to wrap all items.
+     */
+    layout: Template<Pick<Parameters<NonNullable<TrendingItemsUiProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: TrendingItemsUiProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<TrendingItemsCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 type TrendingItemsWidgetParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -217,9 +225,9 @@ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParam
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: Partial<TrendingItemsWidgetParams<BaseHit>> & TrendingItemsConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

package/es/widgets/trending-items/trending-items.js

@@ -60,6 +60,29 @@ function createRenderer(_ref) {
         data: results
       }));
     } : undefined;
+    var layoutComponent = templates.layout ? function (data) {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "layout",
+        rootTagName: "fragment",
+        data: {
+          items: data.items,
+          templates: {
+            item: templates.item ? function (_ref4) {
+              var item = _ref4.item;
+              return h(TemplateComponent, _extends({}, renderState.templateProps, {
+                templateKey: "item",
+                rootTagName: "fragment",
+                data: item
+              }));
+            } : undefined
+          },
+          cssClasses: {
+            list: data.classNames.list,
+            item: data.classNames.item
+          }
+        }
+      }));
+    } : undefined;
     render(h(TrendingItems, {
       items: items,
       sendEvent: function sendEvent() {},
@@ -67,25 +90,26 @@ function createRenderer(_ref) {
       headerComponent: headerComponent,
       itemComponent: itemComponent,
       emptyComponent: emptyComponent,
+      layout: layoutComponent,
       status: instantSearchInstance.status
     }), containerNode);
   };
 }
 export default (function trendingItems(widgetParams) {
-  var _ref4 = widgetParams || {},
-    container = _ref4.container,
-    facetName = _ref4.facetName,
-    facetValue = _ref4.facetValue,
-    limit = _ref4.limit,
-    queryParameters = _ref4.queryParameters,
-    fallbackParameters = _ref4.fallbackParameters,
-    threshold = _ref4.threshold,
-    escapeHTML = _ref4.escapeHTML,
-    transformItems = _ref4.transformItems,
-    _ref4$templates = _ref4.templates,
-    templates = _ref4$templates === void 0 ? {} : _ref4$templates,
-    _ref4$cssClasses = _ref4.cssClasses,
-    cssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses;
+  var _ref5 = widgetParams || {},
+    container = _ref5.container,
+    facetName = _ref5.facetName,
+    facetValue = _ref5.facetValue,
+    limit = _ref5.limit,
+    queryParameters = _ref5.queryParameters,
+    fallbackParameters = _ref5.fallbackParameters,
+    threshold = _ref5.threshold,
+    escapeHTML = _ref5.escapeHTML,
+    transformItems = _ref5.transformItems,
+    _ref5$templates = _ref5.templates,
+    templates = _ref5$templates === void 0 ? {} : _ref5$templates,
+    _ref5$cssClasses = _ref5.cssClasses,
+    cssClasses = _ref5$cssClasses === void 0 ? {} : _ref5$cssClasses;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.73.4",
+  "version": "4.74.1",
   "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",
@@ -28,13 +28,13 @@
   "dependencies": {
     "@algolia/events": "^4.0.1",
     "@types/dom-speech-recognition": "^0.0.1",
-    "@types/google.maps": "^3.45.3",
+    "@types/google.maps": "^3.55.12",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "3.22.3",
+    "algoliasearch-helper": "3.22.5",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
-    "instantsearch-ui-components": "0.8.0",
+    "instantsearch-ui-components": "0.9.0",
     "preact": "^10.10.0",
     "qs": "^6.5.1 < 6.10",
     "search-insights": "^2.15.0"
@@ -56,15 +56,15 @@
     "watch:es": "yarn --silent build:es:base --watch"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.54.0",
-    "@instantsearch/tests": "1.54.0",
-    "@instantsearch/testutils": "1.43.0",
+    "@instantsearch/mocks": "1.56.0",
+    "@instantsearch/tests": "1.56.0",
+    "@instantsearch/testutils": "1.45.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
-    "algoliasearch": "4.23.2",
+    "algoliasearch": "5.1.1",
     "places.js": "1.17.1",
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "b602bbe90e1f3f6db6e64f70eed5297001742dd4"
+  "gitHead": "56304606586fef7c8d1ae21157752fbec52cc55e"
 }