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

Author: raed667

package.json

@@ -106,7 +106,7 @@
     },
     {
       "path": "packages/recommend/dist/recommend.umd.js",
-      "maxSize": "4.3KB"
+      "maxSize": "4.4KB"
     }
   ]
 }

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,
     },
   });
 }

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,
     },
   });
 }

packages/recommend/src/methods/getRecommendations.ts

@@ -1,6 +1,11 @@
 import { MethodEnum } from '@algolia/requester-common';
 
-import { BaseRecommendClient, RecommendationsQuery, WithRecommendMethods } from '../types';
+import {
+  BaseRecommendClient,
+  RecommendationsQuery,
+  RecommendedForYouQuery,
+  WithRecommendMethods,
+} from '../types';
 import { TrendingQuery } from '../types/TrendingQuery';
 
 type GetRecommendations = (
@@ -9,7 +14,9 @@ type GetRecommendations = (
 
 export const getRecommendations: GetRecommendations = base => {
   return (queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>, requestOptions) => {
-    const requests: ReadonlyArray<RecommendationsQuery | TrendingQuery> = queries.map(query => ({
+    const requests: ReadonlyArray<
+      RecommendationsQuery | TrendingQuery | RecommendedForYouQuery
+    > = 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/getRecommendedForYou.ts

@@ -0,0 +1,29 @@
+import { MethodEnum } from '@algolia/requester-common';
+
+import { BaseRecommendClient, RecommendedForYouQuery, WithRecommendMethods } from '../types';
+
+type GetRecommendedForYou = (
+  base: BaseRecommendClient
+) => WithRecommendMethods<BaseRecommendClient>['getRecommendedForYou'];
+
+export const getRecommendedForYou: GetRecommendedForYou = base => {
+  return (queries: readonly RecommendedForYouQuery[], requestOptions) => {
+    const requests: readonly RecommendedForYouQuery[] = queries.map(query => ({
+      ...query,
+      model: 'recommended-for-you',
+      threshold: query.threshold || 0,
+    }));
+
+    return base.transporter.read(
+      {
+        method: MethodEnum.Post,
+        path: '1/indexes/*/recommendations',
+        data: {
+          requests,
+        },
+        cacheable: true,
+      },
+      requestOptions
+    );
+  };
+};

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';

packages/recommend/src/types/RecommendModel.ts

@@ -3,4 +3,5 @@ export type RecommendModel =
   | 'related-products'
   | 'bought-together'
   | 'looking-similar'
+  | 'recommended-for-you'
   | TrendingModel;

packages/recommend/src/types/RecommendedForYouQuery.ts

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

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';
@@ -72,4 +73,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>>>;
 };

packages/recommend/src/types/index.ts

@@ -15,5 +15,6 @@ export * from './TrendingItemsQuery';
 export * from './TrendingQuery';
 export * from './WithRecommendMethods';
 export * from './LookingSimilarQuery';
+export * from './RecommendedForYouQuery';
 export * from './TrendingFacetHit';
 export * from './TrendingFacetsResponse';

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>

scripts/prepare-playground.sh

@@ -1,2 +1,3 @@
 cp -a packages/algoliasearch/dist/algoliasearch-lite.umd* playground/browser-lite/.
 cp -a packages/algoliasearch/dist/algoliasearch.umd* playground/browser/.
+cp -a packages/recommend/dist/recommend.umd* playground/browser/.