feat(recommend): Add trending types and methods (#1396)

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>

Author: SophieManley03

package.json

@@ -105,7 +105,7 @@
  },
  {
 "path": "packages/recommend/dist/recommend.umd.js",
-"maxSize": "4.1KB"
+"maxSize": "4.2KB"
  }
  ]
 }

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

@@ -0,0 +1,46 @@
+import{TestSuite}from'../../../client-common/src/__tests__/TestSuite';
+
+constrecommend=newTestSuite('recommend').recommend;
+
+functioncreateMockedClient(){
+constclient=recommend('appId','apiKey');
+jest.spyOn(client.transporter,'read').mockImplementation(()=>Promise.resolve());
+
+returnclient;
+}
+
+describe('getTrendingFacets',()=>{
+test('builds the request',async()=>{
+constclient=createMockedClient();
+
+awaitclient.getTrendingFacets(
+[
+{
+indexName: 'products',
+facetName: 'company',
+},
+],
+{}
+);
+
+expect(client.transporter.read).toHaveBeenCalledTimes(1);
+expect(client.transporter.read).toHaveBeenCalledWith(
+{
+cacheable: true,
+data: {
+requests: [
+{
+indexName: 'products',
+model: 'trending-facets',
+facetName: 'company',
+threshold: 0,
+},
+],
+},
+method: 'POST',
+path: '1/indexes/*/recommendations',
+},
+{}
+);
+});
+});

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

@@ -0,0 +1,44 @@
+import{TestSuite}from'../../../client-common/src/__tests__/TestSuite';
+
+constrecommend=newTestSuite('recommend').recommend;
+
+functioncreateMockedClient(){
+constclient=recommend('appId','apiKey');
+jest.spyOn(client.transporter,'read').mockImplementation(()=>Promise.resolve());
+
+returnclient;
+}
+
+describe('getTrendingItems',()=>{
+test('builds the request',async()=>{
+constclient=createMockedClient();
+
+awaitclient.getTrendingItems(
+[
+{
+indexName: 'products',
+},
+],
+{}
+);
+
+expect(client.transporter.read).toHaveBeenCalledTimes(1);
+expect(client.transporter.read).toHaveBeenCalledWith(
+{
+cacheable: true,
+data: {
+requests: [
+{
+indexName: 'products',
+model: 'trending-items',
+threshold: 0,
+},
+],
+},
+method: 'POST',
+path: '1/indexes/*/recommendations',
+},
+{}
+);
+});
+});

packages/recommend/src/builds/browser.ts

@@ -8,7 +8,13 @@ import { createBrowserXhrRequester } from '@algolia/requester-browser-xhr';
 import{createUserAgent}from'@algolia/transporter';
 
 import{createRecommendClient}from'../createRecommendClient';
-import{getFrequentlyBoughtTogether,getRecommendations,getRelatedProducts}from'../methods';
+import{
+getFrequentlyBoughtTogether,
+getRecommendations,
+getRelatedProducts,
+getTrendingFacets,
+getTrendingItems,
+}from'../methods';
 import{BaseRecommendClient,RecommendOptions,WithRecommendMethods}from'../types';
 
 exportdefaultfunctionrecommend(
@@ -47,6 +53,8 @@ export default function recommend(
  getFrequentlyBoughtTogether,
  getRecommendations,
  getRelatedProducts,
+ getTrendingFacets,
+ getTrendingItems,
 },
 });
 }

packages/recommend/src/builds/node.ts

@@ -7,7 +7,13 @@ import { createNodeHttpRequester } from '@algolia/requester-node-http';
 import{createUserAgent}from'@algolia/transporter';
 
 import{createRecommendClient}from'../createRecommendClient';
-import{getFrequentlyBoughtTogether,getRecommendations,getRelatedProducts}from'../methods';
+import{
+getFrequentlyBoughtTogether,
+getRecommendations,
+getRelatedProducts,
+getTrendingFacets,
+getTrendingItems,
+}from'../methods';
 import{BaseRecommendClient,RecommendOptions,WithRecommendMethods}from'../types';
 
 exportdefaultfunctionrecommend(
@@ -41,6 +47,8 @@ export default function recommend(
  getFrequentlyBoughtTogether,
  getRecommendations,
  getRelatedProducts,
+ getTrendingFacets,
+ getTrendingItems,
 },
 });
 }

packages/recommend/src/methods/getRecommendations.ts

@@ -1,14 +1,19 @@
 import{MethodEnum}from'@algolia/requester-common';
 
-import{BaseRecommendClient,RecommendationsQuery,WithRecommendMethods}from'../types';
+import{
+BaseRecommendClient,
+RecommendationsQuery,
+TrendingQuery,
+WithRecommendMethods,
+}from'../types';
 
 typeGetRecommendations=(
 base: BaseRecommendClient
 )=>WithRecommendMethods<BaseRecommendClient>['getRecommendations'];
 
 exportconstgetRecommendations: GetRecommendations=base=>{
-return(queries: readonlyRecommendationsQuery[],requestOptions)=>{
-constrequests: readonlyRecommendationsQuery[]=queries.map(query=>({
+return(queries: ReadonlyArray<RecommendationsQuery|TrendingQuery>,requestOptions)=>{
+constrequests: ReadonlyArray<RecommendationsQuery|TrendingQuery>=queries.map(query=>({
  ...query,
 // The `threshold` param is required by the endpoint to make it easier
 // to provide a default value later, so we default it in the client

packages/recommend/src/methods/getTrendingFacets.ts

@@ -0,0 +1,32 @@
+import{MethodEnum}from'@algolia/requester-common';
+
+import{BaseRecommendClient,TrendingFacetsQuery,WithRecommendMethods}from'../types';
+
+typeGetTrendingFacets=(
+base: BaseRecommendClient
+)=>WithRecommendMethods<BaseRecommendClient>['getTrendingFacets'];
+
+exportconstgetTrendingFacets: GetTrendingFacets=base=>{
+return(queries: readonlyTrendingFacetsQuery[],requestOptions)=>{
+constrequests: readonlyTrendingFacetsQuery[]=queries.map(query=>({
+ ...query,
+model: 'trending-facets',
+// The `threshold` param is required by the endpoint to make it easier
+// to provide a default value later, so we default it in the client
+// so that users don't have to provide a value.
+threshold: query.threshold||0,
+}));
+
+returnbase.transporter.read(
+{
+method: MethodEnum.Post,
+path: '1/indexes/*/recommendations',
+data: {
+ requests,
+},
+cacheable: true,
+},
+requestOptions
+);
+};
+};

packages/recommend/src/methods/getTrendingItems.ts

@@ -0,0 +1,32 @@
+import{MethodEnum}from'@algolia/requester-common';
+
+import{BaseRecommendClient,TrendingItemsQuery,WithRecommendMethods}from'../types';
+
+typeGetTrendingItems=(
+base: BaseRecommendClient
+)=>WithRecommendMethods<BaseRecommendClient>['getTrendingItems'];
+
+exportconstgetTrendingItems: GetTrendingItems=base=>{
+return(queries: readonlyTrendingItemsQuery[],requestOptions)=>{
+constrequests: readonlyTrendingItemsQuery[]=queries.map(query=>({
+ ...query,
+model: 'trending-items',
+// The `threshold` param is required by the endpoint to make it easier
+// to provide a default value later, so we default it in the client
+// so that users don't have to provide a value.
+threshold: query.threshold||0,
+}));
+
+returnbase.transporter.read(
+{
+method: MethodEnum.Post,
+path: '1/indexes/*/recommendations',
+data: {
+ requests,
+},
+cacheable: true,
+},
+requestOptions
+);
+};
+};

packages/recommend/src/methods/index.ts

@@ -5,3 +5,5 @@
 export*from'./getFrequentlyBoughtTogether';
 export*from'./getRecommendations';
 export*from'./getRelatedProducts';
+export*from'./getTrendingFacets';
+export*from'./getTrendingItems';

packages/recommend/src/types/RecommendModel.ts

@@ -1 +1,2 @@
-exporttypeRecommendModel='related-products'|'bought-together';
+exporttypeRecommendModel='related-products'|'bought-together'|TrendingModel;
+exporttypeTrendingModel='trending-items'|'trending-facets';