fix(recommend): update recommended-for-you model type (#1500)

* fix(recommend): update recommended-for-you model type * fix RecommendedForYouQuery by removing model * simplify getRecommendations * RecommendedForYouParams
algolia · Jan 9, 2024 · f94ce64 · f94ce64
1 parent 5a2a128
commit f94ce64
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 9 deletions.
diff --git a/packages/recommend/src/methods/getRecommendations.ts b/packages/recommend/src/methods/getRecommendations.ts
@@ -4,16 +4,16 @@ import {
   BaseRecommendClient,
   RecommendationsQuery,
   RecommendedForYouQuery,
+  TrendingQuery,
   WithRecommendMethods,
 } from '../types';
-import { TrendingQuery } from '../types/TrendingQuery';
 
 type GetRecommendations = (
   base: BaseRecommendClient
 ) => WithRecommendMethods<BaseRecommendClient>['getRecommendations'];
 
 export const getRecommendations: GetRecommendations = base => {
-  return (queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>, requestOptions) => {
+  return (queries, requestOptions) => {
     const requests: ReadonlyArray<
       RecommendationsQuery | TrendingQuery | RecommendedForYouQuery
     > = queries.map(query => ({

diff --git a/packages/recommend/src/methods/getRecommendedForYou.ts b/packages/recommend/src/methods/getRecommendedForYou.ts
@@ -1,13 +1,18 @@
 import { MethodEnum } from '@algolia/requester-common';
 
-import { BaseRecommendClient, RecommendedForYouQuery, WithRecommendMethods } from '../types';
+import {
+  BaseRecommendClient,
+  RecommendedForYouParams,
+  RecommendedForYouQuery,
+  WithRecommendMethods,
+} from '../types';
 
 type GetRecommendedForYou = (
   base: BaseRecommendClient
 ) => WithRecommendMethods<BaseRecommendClient>['getRecommendedForYou'];
 
 export const getRecommendedForYou: GetRecommendedForYou = base => {
-  return (queries: readonly RecommendedForYouQuery[], requestOptions) => {
+  return (queries: readonly RecommendedForYouParams[], requestOptions) => {
     const requests: readonly RecommendedForYouQuery[] = queries.map(query => ({
       ...query,
       model: 'recommended-for-you',

diff --git a/packages/recommend/src/types/RecommendationsQuery.ts b/packages/recommend/src/types/RecommendationsQuery.ts
@@ -1,4 +1,3 @@
-import { RecommendModel } from './RecommendModel';
 import { RecommendSearchOptions } from './RecommendSearchOptions';
 
 export type RecommendationsQuery = {
@@ -10,7 +9,7 @@ export type RecommendationsQuery = {
   /**
    * The name of the Recommendation model to use.
    */
-  readonly model: RecommendModel;
+  readonly model: 'related-products' | 'bought-together' | 'looking-similar';
 
   /**
    * The `objectID` of the item to get recommendations for.

diff --git a/packages/recommend/src/types/RecommendedForYouQuery.ts b/packages/recommend/src/types/RecommendedForYouQuery.ts
@@ -5,6 +5,7 @@ export type RecommendedForYouQuery = Omit<
   RecommendationsQuery,
   'model' | 'objectID' | 'queryParameters'
 > & {
+  readonly model: 'recommended-for-you';
   /**
    * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
    */
@@ -17,3 +18,8 @@ export type RecommendedForYouQuery = Omit<
     readonly userToken: string;
   };
 };
+
+/**
+ * The parameters used for `getRecommendedForYou` method.
+ */
+export type RecommendedForYouParams = Omit<RecommendedForYouQuery, 'model'>;
diff --git a/packages/recommend/src/types/WithRecommendMethods.ts b/packages/recommend/src/types/WithRecommendMethods.ts
@@ -1,7 +1,7 @@
 import { SearchOptions, SearchResponse } from '@algolia/client-search';
 import { RequestOptions } from '@algolia/transporter';
 
-import { RecommendedForYouQuery } from '../builds/node';
+import { RecommendedForYouParams, RecommendedForYouQuery } from '../builds/node';
 import { FrequentlyBoughtTogetherQuery } from './FrequentlyBoughtTogetherQuery';
 import { LookingSimilarQuery } from './LookingSimilarQuery';
 import { RecommendationsQuery } from './RecommendationsQuery';
@@ -30,7 +30,7 @@ export type WithRecommendMethods<TType> = TType & {
    * Returns recommendations.
    */
   readonly getRecommendations: <TObject>(
-    queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>,
+    queries: ReadonlyArray<RecommendationsQuery | TrendingQuery | RecommendedForYouQuery>,
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 
@@ -78,7 +78,7 @@ export type WithRecommendMethods<TType> = TType & {
    * Returns Recommended for you
    */
   readonly getRecommendedForYou: <TObject>(
-    queries: readonly RecommendedForYouQuery[],
+    queries: readonly RecommendedForYouParams[],
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
 };