feat: accept multiple objectIDs

README.md

@@ -30,7 +30,7 @@ Then, use the `Recommendations` component:
   model="related-products"
   searchClient={searchClient}
   indexName="YOUR_SOURCE_INDEX_NAME"
-  objectID={objectID}
+  objectIDs={[objectID]}
   hitComponent={Hit}
 />
 
@@ -39,7 +39,7 @@ Then, use the `Recommendations` component:
   model="bought-together"
   searchClient={searchClient}
   indexName="YOUR_SOURCE_INDEX_NAME"
-  objectID={objectID}
+  objectIDs={[objectID]}
   hitComponent={Hit}
 />
 ```
@@ -64,11 +64,11 @@ The initialized Algolia search client.
 
 The name of the products index.
 
-### `objectID`
+### `objectIDs`
 
-> `string` | **required**
+> `string[` | **required**
 
-The objectID of the product to get recommendations from
+An array of object IDs of the products to get recommendations from.
 
 ### `hitComponent`
 

examples/demo/src/App.js

@@ -118,7 +118,7 @@ function App() {
           <FrequentlyBoughtTogether
             searchClient={searchClient}
             indexName={indexName}
-            objectID={selectedProduct.objectID}
+            objectIDs={[selectedProduct.objectID]}
             hitComponent={({ hit }) => <Hit hit={hit} insights={insights} />}
             maxRecommendations={3}
             searchParameters={{
@@ -130,7 +130,7 @@ function App() {
           <RelatedProductsSlider
             searchClient={searchClient}
             indexName={indexName}
-            objectID={selectedProduct.objectID}
+            objectIDs={[selectedProduct.objectID]}
             hitComponent={({ hit }) => <Hit hit={hit} insights={insights} />}
             maxRecommendations={10}
             translations={{
@@ -151,7 +151,7 @@ function App() {
           <RelatedProducts
             searchClient={searchClient}
             indexName={indexName}
-            objectID={selectedProduct.objectID}
+            objectIDs={[selectedProduct.objectID]}
             hitComponent={({ hit }) => <Hit hit={hit} insights={insights} />}
             maxRecommendations={10}
             translations={{

packages/react-recommendations/src/FrequentlyBoughtTogether.tsx

@@ -60,7 +60,7 @@ export function FrequentlyBoughtTogether<TObject extends ProductBaseRecord>(
 FrequentlyBoughtTogether.propTypes = {
   searchClient: PropTypes.object.isRequired,
   indexName: PropTypes.string.isRequired,
-  objectID: PropTypes.string.isRequired,
+  objectIDs: PropTypes.arrayOf(PropTypes.string).isRequired,
   hitComponent: PropTypes.elementType.isRequired,
 
   maxRecommendations: PropTypes.number,

packages/react-recommendations/src/Recommendations.tsx

@@ -56,7 +56,7 @@ Recommendations.propTypes = {
   model: PropTypes.string.isRequired,
   searchClient: PropTypes.object.isRequired,
   indexName: PropTypes.string.isRequired,
-  objectID: PropTypes.string.isRequired,
+  objectIDs: PropTypes.arrayOf(PropTypes.string).isRequired,
   hitComponent: PropTypes.elementType.isRequired,
 
   fallbackFilters: PropTypes.arrayOf(

packages/react-recommendations/src/RelatedProducts.tsx

@@ -62,7 +62,7 @@ export function RelatedProducts<TObject extends ProductBaseRecord>(
 RelatedProducts.propTypes = {
   searchClient: PropTypes.object.isRequired,
   indexName: PropTypes.string.isRequired,
-  objectID: PropTypes.string.isRequired,
+  objectIDs: PropTypes.arrayOf(PropTypes.string).isRequired,
   hitComponent: PropTypes.elementType.isRequired,
 
   fallbackFilters: PropTypes.arrayOf(

packages/react-recommendations/src/RelatedProductsSlider.tsx

@@ -180,7 +180,7 @@ export function RelatedProductsSlider<TObject extends ProductBaseRecord>(
 RelatedProductsSlider.propTypes = {
   searchClient: PropTypes.object.isRequired,
   indexName: PropTypes.string.isRequired,
-  objectID: PropTypes.string.isRequired,
+  objectIDs: PropTypes.arrayOf(PropTypes.string).isRequired,
   hitComponent: PropTypes.elementType.isRequired,
 
   fallbackFilters: PropTypes.arrayOf(

packages/react-recommendations/src/__tests__/Recommendations.test.tsx

@@ -1,7 +1,7 @@
 import { act, render, waitFor } from '@testing-library/react';
 import React from 'react';
 
-import { createSingleSearchResponse } from '../../../../test-utils/createApiResponse';
+import { createMultiSearchResponse } from '../../../../test-utils/createApiResponse';
 import { createSearchClient } from '../../../../test-utils/createSearchClient';
 import { Recommendations } from '../Recommendations';
 
@@ -34,17 +34,17 @@ function Hit({ hit }) {
 
 function createRecommendationsClient() {
   const index = {
-    getObject: jest.fn(() => Promise.resolve(hit)),
+    getObjects: jest.fn(() => Promise.resolve({ results: [hit] })),
+  };
+  const searchClient = createSearchClient({
+    initIndex: jest.fn(() => index),
     search: jest.fn(() =>
       Promise.resolve(
-        createSingleSearchResponse({
+        createMultiSearchResponse({
           hits: [hit],
         })
       )
     ),
-  };
-  const searchClient = createSearchClient({
-    initIndex: jest.fn(() => index),
   });
 
   return {
@@ -63,7 +63,7 @@ describe('Recommendations', () => {
           model="related-products"
           searchClient={searchClient}
           indexName="indexName"
-          objectID="objectID"
+          objectIDs={['objectID']}
           hitComponent={Hit}
         />
       );
@@ -73,22 +73,27 @@ describe('Recommendations', () => {
     expect(searchClient.initIndex).toHaveBeenCalledWith(
       'ai_recommend_related-products_indexName'
     );
-    expect(index.getObject).toHaveBeenCalledTimes(1);
-    expect(index.getObject).toHaveBeenCalledWith('objectID');
+    expect(index.getObjects).toHaveBeenCalledTimes(1);
+    expect(index.getObjects).toHaveBeenCalledWith(['objectID']);
 
     await waitFor(() => {
-      expect(index.search).toHaveBeenCalledTimes(1);
-      expect(index.search).toHaveBeenCalledWith('', {
-        analytics: false,
-        analyticsTags: ['alg-recommend_related-products'],
-        clickAnalytics: false,
-        enableABTest: false,
-        filters: 'NOT objectID:objectID',
-        hitsPerPage: 0,
-        optionalFilters: [],
-        ruleContexts: ['alg-recommend_related-products_objectID'],
-        typoTolerance: false,
-      });
+      expect(searchClient.search).toHaveBeenCalledTimes(1);
+      expect(searchClient.search).toHaveBeenCalledWith([
+        {
+          indexName: 'indexName',
+          params: {
+            analytics: false,
+            analyticsTags: ['alg-recommend_related-products'],
+            clickAnalytics: false,
+            enableABTest: false,
+            filters: 'NOT objectID:objectID',
+            hitsPerPage: 0,
+            optionalFilters: [],
+            ruleContexts: ['alg-recommend_related-products_objectID'],
+            typoTolerance: false,
+          },
+        },
+      ]);
     });
   });
 
@@ -101,7 +106,7 @@ describe('Recommendations', () => {
           model="bought-together"
           searchClient={searchClient}
           indexName="indexName"
-          objectID="objectID"
+          objectIDs={['objectID']}
           hitComponent={Hit}
         />
       );
@@ -111,22 +116,27 @@ describe('Recommendations', () => {
     expect(searchClient.initIndex).toHaveBeenCalledWith(
       'ai_recommend_bought-together_indexName'
     );
-    expect(index.getObject).toHaveBeenCalledTimes(1);
-    expect(index.getObject).toHaveBeenCalledWith('objectID');
+    expect(index.getObjects).toHaveBeenCalledTimes(1);
+    expect(index.getObjects).toHaveBeenCalledWith(['objectID']);
 
     await waitFor(() => {
-      expect(index.search).toHaveBeenCalledTimes(1);
-      expect(index.search).toHaveBeenCalledWith('', {
-        analytics: false,
-        analyticsTags: ['alg-recommend_bought-together'],
-        clickAnalytics: false,
-        enableABTest: false,
-        filters: 'NOT objectID:objectID',
-        hitsPerPage: 0,
-        optionalFilters: [],
-        ruleContexts: ['alg-recommend_bought-together_objectID'],
-        typoTolerance: false,
-      });
+      expect(searchClient.search).toHaveBeenCalledTimes(1);
+      expect(searchClient.search).toHaveBeenCalledWith([
+        {
+          indexName: 'indexName',
+          params: {
+            analytics: false,
+            analyticsTags: ['alg-recommend_bought-together'],
+            clickAnalytics: false,
+            enableABTest: false,
+            filters: 'NOT objectID:objectID',
+            hitsPerPage: 0,
+            optionalFilters: [],
+            ruleContexts: ['alg-recommend_bought-together_objectID'],
+            typoTolerance: false,
+          },
+        },
+      ]);
     });
   });
 });

packages/react-recommendations/src/types/ProductRecord.ts

@@ -0,0 +1,6 @@
+export type ProductRecord<TObject> = TObject & {
+  __indexName: string;
+  __queryID: string | undefined;
+  __position: number;
+  __recommendScore: number | null;
+};

packages/react-recommendations/src/types/index.ts

@@ -1,5 +1,6 @@
-export * from './UseRecommendationsInternalProps';
 export * from './ProductBaseRecord';
+export * from './ProductRecord';
 export * from './RecommendationModel';
 export * from './RecommendationRecord';
 export * from './RecommendationTranslations';
+export * from './UseRecommendationsInternalProps';

packages/react-recommendations/src/useFrequentlyBoughtTogether.ts

@@ -10,7 +10,7 @@ import {
 
 export type UseFrequentlyBoughtTogetherProps = {
   indexName: string;
-  objectID: string;
+  objectIDs: string[];
   searchClient: SearchClient;
 
   maxRecommendations?: number;