fix: remove items for facet as in the search and use it within trending-item

Author: SophieManley03

packages/recommend/src/__tests__/getTrendingGlobalItems.test.ts renamed to packages/recommend/src/__tests__/getTrendingItems.test.ts

@@ -9,11 +9,11 @@ function createMockedClient() {
   return client;
 }
 
-describe('getTrendingGlobalItems', () => {
+describe('getTrendingItems', () => {
   test('builds the request', async () => {
     const client = createMockedClient();
 
-    await client.getTrendingGlobalItems(
+    await client.getTrendingItems(
       [
         {
           indexName: 'products',

packages/recommend/src/__tests__/getTrendingItemsForFacet.test.ts

@@ -13,8 +13,7 @@ import {
   getRecommendations,
   getRelatedProducts,
   getTrendingFacets,
-  getTrendingGlobalItems,
-  getTrendingItemsForFacet,
+  getTrendingItems,
 } from '../methods';
 import { BaseRecommendClient, RecommendOptions, WithRecommendMethods } from '../types';
 
@@ -55,8 +54,7 @@ export default function recommend(
       getRecommendations,
       getRelatedProducts,
       getTrendingFacets,
-      getTrendingGlobalItems,
-      getTrendingItemsForFacet,
+      getTrendingItems,
     },
   });
 }

packages/recommend/src/builds/browser.ts

@@ -12,8 +12,7 @@ import {
   getRecommendations,
   getRelatedProducts,
   getTrendingFacets,
-  getTrendingGlobalItems,
-  getTrendingItemsForFacet,
+  getTrendingItems,
 } from '../methods';
 import { BaseRecommendClient, RecommendOptions, WithRecommendMethods } from '../types';
 
@@ -49,8 +48,7 @@ export default function recommend(
       getRecommendations,
       getRelatedProducts,
       getTrendingFacets,
-      getTrendingGlobalItems,
-      getTrendingItemsForFacet,
+      getTrendingItems,
     },
   });
 }

packages/recommend/src/builds/node.ts

@@ -1,14 +1,14 @@
 import { MethodEnum } from '@algolia/requester-common';
 
-import { BaseRecommendClient, TrendingGlobalItemsQuery, WithRecommendMethods } from '../types';
+import { BaseRecommendClient, TrendingItemsQuery, WithRecommendMethods } from '../types';
 
-type GetTrendingGlobalItems = (
+type GetTrendingItems = (
   base: BaseRecommendClient
-) => WithRecommendMethods<BaseRecommendClient>['getTrendingGlobalItems'];
+) => WithRecommendMethods<BaseRecommendClient>['getTrendingItems'];
 
-export const getTrendingGlobalItems: GetTrendingGlobalItems = base => {
-  return (queries: readonly TrendingGlobalItemsQuery[], requestOptions) => {
-    const requests: readonly TrendingGlobalItemsQuery[] = queries.map(query => ({
+export const getTrendingItems: GetTrendingItems = base => {
+  return (queries: readonly TrendingItemsQuery[], requestOptions) => {
+    const requests: readonly TrendingItemsQuery[] = queries.map(query => ({
       ...query,
       model: 'trending-items',
       // The `threshold` param is required by the endpoint to make it easier

packages/recommend/src/methods/getTrendingGlobalItems.ts renamed to packages/recommend/src/methods/getTrendingItems.ts

@@ -6,5 +6,4 @@ export * from './getFrequentlyBoughtTogether';
 export * from './getRecommendations';
 export * from './getRelatedProducts';
 export * from './getTrendingFacets';
-export * from './getTrendingGlobalItems';
-export * from './getTrendingItemsForFacet';
+export * from './getTrendingItems';

packages/recommend/src/methods/getTrendingItemsForFacet.ts

@@ -0,0 +1,3 @@
+import { RecommendationsQuery } from './RecommendationsQuery';
+
+export type TrendingItemsQuery = Omit<RecommendationsQuery, 'model' | 'objectID'>;

packages/recommend/src/methods/index.ts

@@ -5,8 +5,7 @@ import { FrequentlyBoughtTogetherQuery } from './FrequentlyBoughtTogetherQuery';
 import { RecommendationsQuery } from './RecommendationsQuery';
 import { RelatedProductsQuery } from './RelatedProductsQuery';
 import { TrendingFacetsQuery } from './TrendingFacetsQuery';
-import { TrendingGlobalItemsQuery } from './TrendingGlobalItemsQuery';
-import { TrendingItemsForFacetQuery } from './TrendingItemsForFacetQuery';
+import { TrendingItemsQuery } from './TrendingItemsQuery';
 
 export type WithRecommendMethods<TType> = TType & {
   /**
@@ -36,16 +35,8 @@ export type WithRecommendMethods<TType> = TType & {
   /**
    * Returns trending items
    */
-  readonly getTrendingGlobalItems: <TObject>(
-    queries: readonly TrendingGlobalItemsQuery[],
-    requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-
-  /**
-   * Returns trending items per facet
-   */
-  readonly getTrendingItemsForFacet: <TObject>(
-    queries: readonly TrendingItemsForFacetQuery[],
+  readonly getTrendingItems: <TObject>(
+    queries: readonly TrendingItemsQuery[],
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
 

packages/recommend/src/types/TrendingGlobalItemsQuery.ts

@@ -11,6 +11,5 @@ export * from './RecommendSearchOptions';
 export * from './RecommendationsQuery';
 export * from './RelatedProductsQuery';
 export * from './TrendingFacetsQuery';
-export * from './TrendingGlobalItemsQuery';
-export * from './TrendingItemsForFacetQuery';
+export * from './TrendingItemsQuery';
 export * from './WithRecommendMethods';