fix(recommend): rename maxRecommendations to limit (#6196)

This is consistent with other widgets that don't have pagination like refinementList
algolia · May 16, 2024 · b6037c0 · b6037c0
1 parent 6ccffdf
commit b6037c0
Show file tree

Hide file tree

Showing 25 changed files with 55 additions and 67 deletions.
diff --git a/...c/connectors/frequently-bought-together/__tests__/connectFrequentlyBoughtTogether-test.ts b/...c/connectors/frequently-bought-together/__tests__/connectFrequentlyBoughtTogether-test.ts
@@ -83,7 +83,7 @@ describe('connectFrequentlyBoughtTogether', () => {
       const makeWidget = connectFrequentlyBoughtTogether(render);
       const widget = makeWidget({
         objectIDs: ['1', '2'],
-        maxRecommendations: 10,
+        limit: 10,
         threshold: 95,
         queryParameters: { userToken: 'token' },
         escapeHTML: false,

diff --git a/...antsearch.js/src/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.ts b/...antsearch.js/src/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.ts
@@ -42,7 +42,7 @@ export type FrequentlyBoughtTogetherConnectorParams<
   /**
    * The maximum number of recommendations to return.
    */
-  maxRecommendations?: number;
+  limit?: number;
 
   /**
    * Parameters to pass to the request.
@@ -90,7 +90,7 @@ const connectFrequentlyBoughtTogether: FrequentlyBoughtTogetherConnector =
           FrequentlyBoughtTogetherConnectorParams['transformItems']
         >,
         objectIDs,
-        maxRecommendations,
+        limit,
         threshold,
         queryParameters,
       } = widgetParams || {};
@@ -156,7 +156,7 @@ const connectFrequentlyBoughtTogether: FrequentlyBoughtTogetherConnector =
               acc.addFrequentlyBoughtTogether({
                 objectID,
                 threshold,
-                maxRecommendations,
+                maxRecommendations: limit,
                 queryParameters: {
                   ...queryParameters,
                   ...(escapeHTML ? TAG_PLACEHOLDER : {}),

diff --git a/packages/instantsearch.js/src/connectors/looking-similar/connectLookingSimilar.ts b/packages/instantsearch.js/src/connectors/looking-similar/connectLookingSimilar.ts
@@ -32,7 +32,7 @@ export type LookingSimilarConnectorParams<THit extends BaseHit = BaseHit> = {
   /**
    * The number of recommendations to retrieve.
    */
-  maxRecommendations?: number;
+  limit?: number;
   /**
    * The threshold for the recommendations confidence score (between 0 and 100).
    */
@@ -82,7 +82,7 @@ const connectLookingSimilar: LookingSimilarConnector =
         // @MAJOR: this can default to false
         escapeHTML = true,
         objectIDs,
-        maxRecommendations,
+        limit,
         threshold,
         fallbackParameters,
         queryParameters,
@@ -152,7 +152,7 @@ const connectLookingSimilar: LookingSimilarConnector =
             (acc, objectID) =>
               acc.addLookingSimilar({
                 objectID,
-                maxRecommendations,
+                maxRecommendations: limit,
                 threshold,
                 fallbackParameters: {
                   ...fallbackParameters,

diff --git a/packages/instantsearch.js/src/connectors/related-products/connectRelatedProducts.ts b/packages/instantsearch.js/src/connectors/related-products/connectRelatedProducts.ts
@@ -32,7 +32,7 @@ export type RelatedProductsConnectorParams<THit extends BaseHit = BaseHit> = {
   /**
    * The number of recommendations to retrieve.
    */
-  maxRecommendations?: number;
+  limit?: number;
   /**
    * The threshold for the recommendations confidence score (between 0 and 100).
    */
@@ -83,7 +83,7 @@ const connectRelatedProducts: RelatedProductsConnector =
         // @MAJOR: this can default to false
         escapeHTML = true,
         objectIDs,
-        maxRecommendations,
+        limit,
         threshold,
         fallbackParameters,
         queryParameters,
@@ -153,7 +153,7 @@ const connectRelatedProducts: RelatedProductsConnector =
             (acc, objectID) =>
               acc.addRelatedProducts({
                 objectID,
-                maxRecommendations,
+                maxRecommendations: limit,
                 threshold,
                 fallbackParameters: {
                   ...fallbackParameters,

diff --git a/packages/instantsearch.js/src/connectors/trending-items/connectTrendingItems.ts b/packages/instantsearch.js/src/connectors/trending-items/connectTrendingItems.ts
@@ -40,7 +40,7 @@ export type TrendingItemsConnectorParams<THit extends BaseHit = BaseHit> = (
   /**
    * The number of recommendations to retrieve.
    */
-  maxRecommendations?: number;
+  limit?: number;
   /**
    * The threshold for the recommendations confidence score (between 0 and 100).
    */
@@ -89,7 +89,7 @@ const connectTrendingItems: TrendingItemsConnector =
       const {
         facetName,
         facetValue,
-        maxRecommendations,
+        limit,
         threshold,
         fallbackParameters,
         queryParameters,
@@ -156,7 +156,7 @@ const connectTrendingItems: TrendingItemsConnector =
           return state.removeParams(this.$$id!).addTrendingItems({
             facetName,
             facetValue,
-            maxRecommendations,
+            maxRecommendations: limit,
             threshold,
             fallbackParameters: {
               ...fallbackParameters,

diff --git a/...h.js/src/widgets/frequently-bought-together/__tests__/frequently-bought-together.test.tsx b/...h.js/src/widgets/frequently-bought-together/__tests__/frequently-bought-together.test.tsx
@@ -80,9 +80,7 @@ describe('frequentlyBoughtTogether', () => {
 
       search
         .removeWidgets([widget])
-        .addWidgets([
-          frequentlyBoughtTogether({ ...options, maxRecommendations: 0 }),
-        ]);
+        .addWidgets([frequentlyBoughtTogether({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -156,9 +154,7 @@ describe('frequentlyBoughtTogether', () => {
 
       search
         .removeWidgets([widget])
-        .addWidgets([
-          frequentlyBoughtTogether({ ...options, maxRecommendations: 0 }),
-        ]);
+        .addWidgets([frequentlyBoughtTogether({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -243,7 +239,7 @@ describe('frequentlyBoughtTogether', () => {
       search.removeWidgets([widget]).addWidgets([
         frequentlyBoughtTogether({
           ...options,
-          maxRecommendations: 0,
+          limit: 0,
         }),
       ]);
 
@@ -334,7 +330,7 @@ describe('frequentlyBoughtTogether', () => {
       search.removeWidgets([widget]).addWidgets([
         frequentlyBoughtTogether({
           ...options,
-          maxRecommendations: 0,
+          limit: 0,
         }),
       ]);
 

diff --git a/...es/instantsearch.js/src/widgets/frequently-bought-together/frequently-bought-together.tsx b/...es/instantsearch.js/src/widgets/frequently-bought-together/frequently-bought-together.tsx
@@ -174,7 +174,7 @@ const frequentlyBoughtTogether: FrequentlyBoughtTogetherWidget =
     const {
       container,
       objectIDs,
-      maxRecommendations,
+      limit,
       queryParameters,
       threshold,
       escapeHTML,
@@ -203,7 +203,7 @@ const frequentlyBoughtTogether: FrequentlyBoughtTogetherWidget =
     return {
       ...makeWidget({
         objectIDs,
-        maxRecommendations,
+        limit,
         queryParameters,
         threshold,
         escapeHTML,

diff --git a/packages/instantsearch.js/src/widgets/looking-similar/__tests__/looking-similar.test.tsx b/packages/instantsearch.js/src/widgets/looking-similar/__tests__/looking-similar.test.tsx
@@ -80,7 +80,7 @@ describe('lookingSimilar', () => {
 
       search
         .removeWidgets([widget])
-        .addWidgets([lookingSimilar({ ...options, maxRecommendations: 0 })]);
+        .addWidgets([lookingSimilar({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -155,7 +155,7 @@ describe('lookingSimilar', () => {
 
       search
         .removeWidgets([widget])
-        .addWidgets([lookingSimilar({ ...options, maxRecommendations: 0 })]);
+        .addWidgets([lookingSimilar({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -240,7 +240,7 @@ describe('lookingSimilar', () => {
       search.removeWidgets([widget]).addWidgets([
         lookingSimilar({
           ...options,
-          maxRecommendations: 0,
+          limit: 0,
         }),
       ]);
 
@@ -331,7 +331,7 @@ describe('lookingSimilar', () => {
       search.removeWidgets([widget]).addWidgets([
         lookingSimilar({
           ...options,
-          maxRecommendations: 0,
+          limit: 0,
         }),
       ]);
 

diff --git a/packages/instantsearch.js/src/widgets/looking-similar/looking-similar.tsx b/packages/instantsearch.js/src/widgets/looking-similar/looking-similar.tsx
@@ -171,7 +171,7 @@ const lookingSimilar: LookingSimilarWidget = function lookingSimilar(
   const {
     container,
     objectIDs,
-    maxRecommendations,
+    limit,
     queryParameters,
     fallbackParameters,
     threshold,
@@ -200,7 +200,7 @@ const lookingSimilar: LookingSimilarWidget = function lookingSimilar(
   return {
     ...makeWidget({
       objectIDs,
-      maxRecommendations,
+      limit,
       queryParameters,
       fallbackParameters,
       threshold,

diff --git a/packages/instantsearch.js/src/widgets/related-products/__tests__/related-products.test.tsx b/packages/instantsearch.js/src/widgets/related-products/__tests__/related-products.test.tsx
@@ -80,9 +80,7 @@ describe('relatedProducts', () => {
 
       search.removeWidgets([relatedProductsWidget]);
 
-      search.addWidgets([
-        relatedProducts({ ...options, maxRecommendations: 0 }),
-      ]);
+      search.addWidgets([relatedProducts({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -158,9 +156,7 @@ describe('relatedProducts', () => {
 
       search.removeWidgets([relatedProductsWidget]);
 
-      search.addWidgets([
-        relatedProducts({ ...options, maxRecommendations: 0 }),
-      ]);
+      search.addWidgets([relatedProducts({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -245,9 +241,7 @@ describe('relatedProducts', () => {
 
       search.removeWidgets([relatedProductsWidget]);
 
-      search.addWidgets([
-        relatedProducts({ ...options, maxRecommendations: 0 }),
-      ]);
+      search.addWidgets([relatedProducts({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -336,9 +330,7 @@ describe('relatedProducts', () => {
 
       search.removeWidgets([relatedProductsWidget]);
 
-      search.addWidgets([
-        relatedProducts({ ...options, maxRecommendations: 0 }),
-      ]);
+      search.addWidgets([relatedProducts({ ...options, limit: 0 })]);
 
       await wait(0);
 

diff --git a/packages/instantsearch.js/src/widgets/related-products/related-products.tsx b/packages/instantsearch.js/src/widgets/related-products/related-products.tsx
@@ -182,7 +182,7 @@ const relatedProducts: RelatedProductsWidget = function relatedProducts(
   const {
     container,
     objectIDs,
-    maxRecommendations,
+    limit,
     queryParameters,
     fallbackParameters,
     threshold,
@@ -212,7 +212,7 @@ const relatedProducts: RelatedProductsWidget = function relatedProducts(
   return {
     ...makeWidget({
       objectIDs,
-      maxRecommendations,
+      limit,
       queryParameters,
       fallbackParameters,
       threshold,

diff --git a/packages/instantsearch.js/src/widgets/trending-items/__tests__/trending-items.test.tsx b/packages/instantsearch.js/src/widgets/trending-items/__tests__/trending-items.test.tsx
@@ -77,7 +77,7 @@ describe('trendingItems', () => {
 
       search.removeWidgets([trendingItemsWidget]);
 
-      search.addWidgets([trendingItems({ ...options, maxRecommendations: 0 })]);
+      search.addWidgets([trendingItems({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -152,7 +152,7 @@ describe('trendingItems', () => {
 
       search.removeWidgets([trendingItemsWidget]);
 
-      search.addWidgets([trendingItems({ ...options, maxRecommendations: 0 })]);
+      search.addWidgets([trendingItems({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -236,7 +236,7 @@ describe('trendingItems', () => {
 
       search.removeWidgets([trendingItemsWidget]);
 
-      search.addWidgets([trendingItems({ ...options, maxRecommendations: 0 })]);
+      search.addWidgets([trendingItems({ ...options, limit: 0 })]);
 
       await wait(0);
 
@@ -324,7 +324,7 @@ describe('trendingItems', () => {
 
       search.removeWidgets([trendingItemsWidget]);
 
-      search.addWidgets([trendingItems({ ...options, maxRecommendations: 0 })]);
+      search.addWidgets([trendingItems({ ...options, limit: 0 })]);
 
       await wait(0);
 

diff --git a/packages/instantsearch.js/src/widgets/trending-items/trending-items.tsx b/packages/instantsearch.js/src/widgets/trending-items/trending-items.tsx
@@ -181,7 +181,7 @@ const trendingItems: TrendingItemsWidget = function trendingItems(
     container,
     facetName,
     facetValue,
-    maxRecommendations,
+    limit,
     queryParameters,
     fallbackParameters,
     threshold,
@@ -214,7 +214,7 @@ const trendingItems: TrendingItemsWidget = function trendingItems(
   return {
     ...makeWidget({
       ...facetParameters,
-      maxRecommendations,
+      limit,
       queryParameters,
       fallbackParameters,
       threshold,

diff --git a/packages/react-instantsearch/src/widgets/FrequentlyBoughtTogether.tsx b/packages/react-instantsearch/src/widgets/FrequentlyBoughtTogether.tsx
@@ -40,7 +40,7 @@ const FrequentlyBoughtTogetherUiComponent =
 
 export function FrequentlyBoughtTogether<THit extends BaseHit = BaseHit>({
   objectIDs,
-  maxRecommendations,
+  limit,
   threshold,
   queryParameters,
   escapeHTML,
@@ -54,7 +54,7 @@ export function FrequentlyBoughtTogether<THit extends BaseHit = BaseHit>({
   const { items } = useFrequentlyBoughtTogether<THit>(
     {
       objectIDs,
-      maxRecommendations,
+      limit,
       threshold,
       queryParameters,
       escapeHTML,

diff --git a/packages/react-instantsearch/src/widgets/LookingSimilar.tsx b/packages/react-instantsearch/src/widgets/LookingSimilar.tsx
@@ -36,7 +36,7 @@ const LookingSimilarUiComponent = createLookingSimilarComponent({
 
 export function LookingSimilar<THit extends BaseHit = BaseHit>({
   objectIDs,
-  maxRecommendations,
+  limit,
   threshold,
   queryParameters,
   fallbackParameters,
@@ -51,7 +51,7 @@ export function LookingSimilar<THit extends BaseHit = BaseHit>({
   const { items } = useLookingSimilar<THit>(
     {
       objectIDs,
-      maxRecommendations,
+      limit,
       threshold,
       queryParameters,
       fallbackParameters,

diff --git a/packages/react-instantsearch/src/widgets/RelatedProducts.tsx b/packages/react-instantsearch/src/widgets/RelatedProducts.tsx
@@ -36,7 +36,7 @@ const RelatedProductsUiComponent = createRelatedProductsComponent({
 
 export function RelatedProducts<TItem extends BaseHit = BaseHit>({
   objectIDs,
-  maxRecommendations,
+  limit,
   threshold,
   fallbackParameters,
   queryParameters,
@@ -51,7 +51,7 @@ export function RelatedProducts<TItem extends BaseHit = BaseHit>({
   const { items } = useRelatedProducts(
     {
       objectIDs,
-      maxRecommendations,
+      limit,
       threshold,
       fallbackParameters,
       queryParameters,