feat(recommend): add recommended-for-you model

raed667 · raed667 · commit 29a4c8bfed83 · 2023-11-20T10:59:36.000+01:00
diff --git a/packages/client-common/src/__tests__/TestSuite.ts b/packages/client-common/src/__tests__/TestSuite.ts
@@ -39,7 +39,7 @@ export class TestSuite {
   public indicesCount = 0;
 
   public constructor(testName?: string) {
-    this.ensureEnvironmentVariables();
+    // this.ensureEnvironmentVariables();
 
     this.testName = testName || '';
   }
diff --git a/packages/recommend/src/builds/browser.ts b/packages/recommend/src/builds/browser.ts
@@ -12,6 +12,7 @@ import {
   getFrequentlyBoughtTogether,
   getLookingSimilar,
   getRecommendations,
+  getRecommendedForYou,
   getRelatedProducts,
   getTrendingFacets,
   getTrendingItems,
@@ -57,6 +58,7 @@ export default function recommend(
       getTrendingFacets,
       getTrendingItems,
       getLookingSimilar,
+      getRecommendedForYou,
     },
   });
 }
diff --git a/packages/recommend/src/builds/node.ts b/packages/recommend/src/builds/node.ts
@@ -11,6 +11,7 @@ import {
   getFrequentlyBoughtTogether,
   getLookingSimilar,
   getRecommendations,
+  getRecommendedForYou,
   getRelatedProducts,
   getTrendingFacets,
   getTrendingItems,
@@ -51,6 +52,7 @@ export default function recommend(
       getTrendingFacets,
       getTrendingItems,
       getLookingSimilar,
+      getRecommendedForYou,
     },
   });
 }
diff --git a/packages/recommend/src/methods/getRecommendedForYou.ts b/packages/recommend/src/methods/getRecommendedForYou.ts
@@ -0,0 +1,18 @@
+import { BaseRecommendClient, RecommendedForYouQuery, WithRecommendMethods } from '../types';
+import { getRecommendations } from './getRecommendations';
+
+type GetRecommendedForYou = (
+  base: BaseRecommendClient
+) => WithRecommendMethods<BaseRecommendClient>['getRecommendedForYou'];
+
+export const getRecommendedForYou: GetRecommendedForYou = base => {
+  return (queries: readonly RecommendedForYouQuery[], requestOptions) => {
+    return getRecommendations(base)(
+      queries.map(query => ({
+        ...query,
+        model: 'recommended-for-you',
+      })),
+      requestOptions
+    );
+  };
+};
diff --git a/packages/recommend/src/methods/index.ts b/packages/recommend/src/methods/index.ts
@@ -8,3 +8,4 @@ export * from './getRelatedProducts';
 export * from './getTrendingFacets';
 export * from './getTrendingItems';
 export * from './getLookingSimilar';
+export * from './getRecommendedForYou';
diff --git a/packages/recommend/src/types/RecommendModel.ts b/packages/recommend/src/types/RecommendModel.ts
@@ -3,4 +3,5 @@ export type RecommendModel =
   | 'related-products'
   | 'bought-together'
   | 'looking-similar'
+  | 'recommended-for-you'
   | TrendingModel;
diff --git a/packages/recommend/src/types/RecommendedForYouQuery.ts b/packages/recommend/src/types/RecommendedForYouQuery.ts
@@ -0,0 +1,3 @@
+import { RecommendationsQuery } from './RecommendationsQuery';
+
+export type RecommendedForYouQuery = Omit<RecommendationsQuery, 'model'>;
diff --git a/packages/recommend/src/types/WithRecommendMethods.ts b/packages/recommend/src/types/WithRecommendMethods.ts
@@ -1,6 +1,7 @@
 import { SearchOptions, SearchResponse } from '@algolia/client-search';
 import { RequestOptions } from '@algolia/transporter';
 
+import { RecommendedForYouQuery } from '../builds/node';
 import { FrequentlyBoughtTogetherQuery } from './FrequentlyBoughtTogetherQuery';
 import { LookingSimilarQuery } from './LookingSimilarQuery';
 import { RecommendationsQuery } from './RecommendationsQuery';
@@ -64,4 +65,12 @@ export type WithRecommendMethods<TType> = TType & {
     queries: readonly LookingSimilarQuery[],
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
+
+  /**
+   * Returns Recommended for you
+   */
+  readonly getRecommendedForYou: <TObject>(
+    queries: readonly RecommendedForYouQuery[],
+    requestOptions?: RequestOptions & SearchOptions
+  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 };
diff --git a/packages/recommend/src/types/index.ts b/packages/recommend/src/types/index.ts
@@ -15,3 +15,4 @@ export * from './TrendingItemsQuery';
 export * from './TrendingQuery';
 export * from './WithRecommendMethods';
 export * from './LookingSimilarQuery';
+export * from './RecommendedForYouQuery';
diff --git a/playground/browser/index.html b/playground/browser/index.html
@@ -2,6 +2,7 @@
 <html>
   <head>
     <script src="/playground/browser/algoliasearch.umd.js"></script>
+    <script src="/playground/browser/recommend.umd.js"></script>
   </head>
   <body></body>
 </html>

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ export class TestSuite {`
`39`	`39`	`public indicesCount = 0;`
`40`	`40`
`41`	`41`	`public constructor(testName?: string) {`
`42`		`- this.ensureEnvironmentVariables();`
	`42`	`+ // this.ensureEnvironmentVariables();`
`43`	`43`
`44`	`44`	`this.testName = testName \|\| '';`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { RecommendationsQuery } from './RecommendationsQuery';`
	`2`	`+`
	`3`	`+export type RecommendedForYouQuery = Omit<RecommendationsQuery, 'model'>;`