fix(recommend): Add Type RecommendQueriesResponse from old MultipleQu…

…eriesResponse for recommend (#1472)
algolia · Jul 20, 2023 · 36285b2 · 36285b2
1 parent a38a628
commit 36285b2
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 9 deletions.
diff --git a/packages/recommend/src/__tests__/getRecommendations.test.ts b/packages/recommend/src/__tests__/getRecommendations.test.ts
@@ -2,9 +2,21 @@ import { TestSuite } from '../../../client-common/src/__tests__/TestSuite';
 
 const recommend = new TestSuite('recommend').recommend;
 
-function createMockedClient() {
+function createMockedClient<TObject>() {
   const client = recommend('appId', 'apiKey');
-  jest.spyOn(client.transporter, 'read').mockImplementation(() => Promise.resolve());
+  jest.spyOn(client.transporter, 'read').mockImplementation(() =>
+    Promise.resolve({
+      results: [
+        {
+          hits: [
+            {
+              objectID: '1',
+            },
+          ],
+        },
+      ],
+    })
+  );
 
   return client;
 }
@@ -197,4 +209,25 @@ describe('getRecommendations', () => {
       {}
     );
   });
+
+  test('returns recommendations results', async () => {
+    const client = createMockedClient();
+
+    const recommendations = await client.getRecommendations<any>(
+      [
+        {
+          model: 'bought-together',
+          indexName: 'products',
+          objectID: 'B018APC4LE',
+        },
+      ],
+      {}
+    );
+
+    expect(recommendations.results[0].hits).toEqual([
+      {
+        objectID: '1',
+      },
+    ]);
+  });
 });
diff --git a/packages/recommend/src/types/WithRecommendMethods.ts b/packages/recommend/src/types/WithRecommendMethods.ts
@@ -1,4 +1,4 @@
-import { MultipleQueriesResponse, SearchOptions } from '@algolia/client-search';
+import { SearchOptions, SearchResponse } from '@algolia/client-search';
 import { RequestOptions } from '@algolia/transporter';
 
 import { FrequentlyBoughtTogetherQuery } from './FrequentlyBoughtTogetherQuery';
@@ -9,52 +9,59 @@ import { TrendingFacetsQuery } from './TrendingFacetsQuery';
 import { TrendingItemsQuery } from './TrendingItemsQuery';
 import { TrendingQuery } from './TrendingQuery';
 
+export type RecommendQueriesResponse<TObject> = {
+  /**
+   * The list of results.
+   */
+  readonly results: ReadonlyArray<SearchResponse<TObject>>;
+};
+
 export type WithRecommendMethods<TType> = TType & {
   /**
    * Returns recommendations.
    */
   readonly getRecommendations: <TObject>(
     queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>,
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 
   /**
    * Returns [Related Products](https://algolia.com/doc/guides/algolia-ai/recommend/#related-products).
    */
   readonly getRelatedProducts: <TObject>(
     queries: readonly RelatedProductsQuery[],
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 
   /**
    * Returns [Frequently Bought Together](https://algolia.com/doc/guides/algolia-ai/recommend/#frequently-bought-together) products.
    */
   readonly getFrequentlyBoughtTogether: <TObject>(
     queries: readonly FrequentlyBoughtTogetherQuery[],
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 
   /**
    * Returns trending items
    */
   readonly getTrendingItems: <TObject>(
     queries: readonly TrendingItemsQuery[],
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 
   /**
    * Returns trending items per facet
    */
   readonly getTrendingFacets: <TObject>(
     queries: readonly TrendingFacetsQuery[],
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 
   /**
    * Returns Looking Similar
    */
   readonly getLookingSimilar: <TObject>(
     queries: readonly LookingSimilarQuery[],
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 };