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

Author: raed667

packages/recommend/src/methods/getRecommendations.ts

@@ -3,7 +3,7 @@ import { MethodEnum } from '@algolia/requester-common';
 import {
   BaseRecommendClient,
   RecommendationsQuery,
-  RecommendedForYouQuery,
+  RecommendationsQueryWithoutObjectID,
   WithRecommendMethods,
 } from '../types';
 import { TrendingQuery } from '../types/TrendingQuery';
@@ -13,9 +13,14 @@ type GetRecommendations = (
 ) => WithRecommendMethods<BaseRecommendClient>['getRecommendations'];
 
 export const getRecommendations: GetRecommendations = base => {
-  return (queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>, requestOptions) => {
+  return (
+    queries: ReadonlyArray<
+      RecommendationsQuery | TrendingQuery | RecommendationsQueryWithoutObjectID
+    >,
+    requestOptions
+  ) => {
     const requests: ReadonlyArray<
-      RecommendationsQuery | TrendingQuery | RecommendedForYouQuery
+      RecommendationsQuery | TrendingQuery | RecommendationsQueryWithoutObjectID
     > = queries.map(query => ({
       ...query,
       // The `threshold` param is required by the endpoint to make it easier

packages/recommend/src/types/RecommendationsQuery.ts

@@ -39,3 +39,18 @@ export type RecommendationsQuery = {
    */
   readonly fallbackParameters?: RecommendSearchOptions;
 };
+
+/**
+ * Base type for models that don't require an `objectID`.
+ *
+ * Currently the only model that doesn't require an `objectID` is `recommended-for-you`.
+ */
+export type RecommendationsQueryWithoutObjectID = Omit<
+  RecommendationsQuery,
+  'objectID' | 'model'
+> & {
+  /**
+   * The name of the Recommendation model to use.
+   */
+  readonly model: 'recommended-for-you';
+};

packages/recommend/src/types/RecommendedForYouQuery.ts

@@ -1,10 +1,11 @@
-import { RecommendationsQuery } from './RecommendationsQuery';
+import { RecommendationsQueryWithoutObjectID } from './RecommendationsQuery';
 import { RecommendSearchOptions } from './RecommendSearchOptions';
 
 export type RecommendedForYouQuery = Omit<
-  RecommendationsQuery,
-  'model' | 'objectID' | 'queryParameters'
+  RecommendationsQueryWithoutObjectID,
+  'model' | 'queryParameters'
 > & {
+  readonly model: 'recommended-for-you';
   /**
    * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
    */

packages/recommend/src/types/WithRecommendMethods.ts

@@ -4,7 +4,7 @@ import { RequestOptions } from '@algolia/transporter';
 import { RecommendedForYouQuery } from '../builds/node';
 import { FrequentlyBoughtTogetherQuery } from './FrequentlyBoughtTogetherQuery';
 import { LookingSimilarQuery } from './LookingSimilarQuery';
-import { RecommendationsQuery } from './RecommendationsQuery';
+import { RecommendationsQuery, RecommendationsQueryWithoutObjectID } from './RecommendationsQuery';
 import { RelatedProductsQuery } from './RelatedProductsQuery';
 import { TrendingFacetsQuery } from './TrendingFacetsQuery';
 import { TrendingFacetsResponse } from './TrendingFacetsResponse';
@@ -30,7 +30,9 @@ export type WithRecommendMethods<TType> = TType & {
    * Returns recommendations.
    */
   readonly getRecommendations: <TObject>(
-    queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>,
+    queries: ReadonlyArray<
+      RecommendationsQuery | TrendingQuery | RecommendationsQueryWithoutObjectID
+    >,
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;