fix: reintroduce trendingQuery

Author: SophieManley03

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';
 
 type GetRecommendations = (
   base: BaseRecommendClient
 ) => WithRecommendMethods<BaseRecommendClient>['getRecommendations'];
 
 export const getRecommendations: GetRecommendations = base => {
-  return (queries: readonly RecommendationsQuery[], requestOptions) => {
-    const requests: readonly RecommendationsQuery[] = queries.map(query => ({
+  return (queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>, requestOptions) => {
+    const requests: 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/types/FrequentlyBoughtTogetherQuery.ts

@@ -2,6 +2,5 @@ import { RecommendationsQuery } from './RecommendationsQuery';
 
 export type FrequentlyBoughtTogetherQuery = Omit<
   RecommendationsQuery,
-  'model' | 'fallbackParameters' | 'facetName' | 'facetValue'
-> &
-  Required<Pick<RecommendationsQuery, 'objectID'>>;
+  'model' | 'fallbackParameters'
+>;

packages/recommend/src/types/RecommendationsQuery.ts

@@ -15,7 +15,7 @@ export type RecommendationsQuery = {
   /**
    * The `objectID` of the item to get recommendations for.
    */
-  readonly objectID?: string;
+  readonly objectID: string;
 
   /**
    * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
@@ -38,14 +38,4 @@ export type RecommendationsQuery = {
    * Additional filters to use as fallback when there aren’t enough recommendations.
    */
   readonly fallbackParameters?: RecommendSearchOptions;
-
-  /**
-   * Used for trending model
-   */
-  readonly facetName?: string;
-
-  /**
-   * Used for trending model
-   */
-  readonly facetValue?: string;
 };

packages/recommend/src/types/RelatedProductsQuery.ts

@@ -1,7 +1,3 @@
 import { RecommendationsQuery } from './RecommendationsQuery';
 
-export type RelatedProductsQuery = Omit<
-  RecommendationsQuery,
-  'model' | 'facetName' | 'facetValue'
-> &
-  Required<Pick<RecommendationsQuery, 'objectID'>>;
+export type RelatedProductsQuery = Omit<RecommendationsQuery, 'model'>;

packages/recommend/src/types/TrendingFacetsQuery.ts

@@ -1,4 +1,3 @@
-import { RecommendationsQuery } from './RecommendationsQuery';
+import { TrendingQuery } from './TrendingQuery';
 
-export type TrendingFacetsQuery = Omit<RecommendationsQuery, 'model' | 'facetValue' | 'objectID'> &
-  Required<Pick<RecommendationsQuery, 'facetName'>>;
+export type TrendingFacetsQuery = Omit<TrendingQuery, 'model' | 'facetValue' | 'objectID'>;

packages/recommend/src/types/TrendingItemsQuery.ts

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

packages/recommend/src/types/TrendingQuery.ts

@@ -0,0 +1,46 @@
+import { TrendingModel } from './RecommendModel';
+import { RecommendSearchOptions } from './RecommendSearchOptions';
+
+export type TrendingQuery = {
+  /**
+   * The name of the target index.
+   */
+  readonly indexName: string;
+
+  /**
+   * The name of the Recommendation model to use.
+   */
+  readonly model: TrendingModel;
+
+  /**
+   * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
+   */
+  readonly threshold?: number;
+
+  /**
+   * How many recommendations to retrieve.
+   */
+  readonly maxRecommendations?: number;
+
+  /**
+   * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
+   */
+  readonly queryParameters?: RecommendSearchOptions;
+
+  /**
+   * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
+   *
+   * Additional filters to use as fallback when there aren’t enough recommendations.
+   */
+  readonly fallbackParameters?: RecommendSearchOptions;
+
+  /**
+   * Used for trending model
+   */
+  readonly facetName?: string;
+
+  /**
+   * Used for trending model
+   */
+  readonly facetValue?: string;
+};

packages/recommend/src/types/index.ts

@@ -11,5 +11,6 @@ export * from './RecommendSearchOptions';
 export * from './RecommendationsQuery';
 export * from './RelatedProductsQuery';
 export * from './TrendingFacetsQuery';
+export * from './TrendingQuery';
 export * from './TrendingItemsQuery';
 export * from './WithRecommendMethods';