fix(recommend): Add a trendingQuery type

Author: SophieManley03

packages/recommend/src/methods/getTrendingFacets.ts

@@ -1,17 +1,31 @@
+import { MethodEnum } from '@algolia/requester-common';
+
 import { BaseRecommendClient, TrendingFacetsQuery, WithRecommendMethods } from '../types';
-import { getRecommendations } from './getRecommendations';
 
 type GetTrendingFacets = (
   base: BaseRecommendClient
 ) => WithRecommendMethods<BaseRecommendClient>['getTrendingFacets'];
 
 export const getTrendingFacets: GetTrendingFacets = base => {
   return (queries: readonly TrendingFacetsQuery[], requestOptions) => {
-    return getRecommendations(base)(
-      queries.map(query => ({
-        ...query,
-        model: 'trending-facets',
-      })),
+    const requests: readonly TrendingFacetsQuery[] = queries.map(query => ({
+      ...query,
+      model: 'trending-facets',
+      // 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
+      // so that users don't have to provide a value.
+      threshold: query.threshold || 0,
+    }));
+
+    return base.transporter.read(
+      {
+        method: MethodEnum.Post,
+        path: '1/indexes/*/recommendations',
+        data: {
+          requests,
+        },
+        cacheable: true,
+      },
       requestOptions
     );
   };

packages/recommend/src/methods/getTrendingGlobalItems.ts

@@ -1,17 +1,31 @@
+import { MethodEnum } from '@algolia/requester-common';
+
 import { BaseRecommendClient, TrendingGlobalItemsQuery, WithRecommendMethods } from '../types';
-import { getRecommendations } from './getRecommendations';
 
 type GetTrendingGlobalItems = (
   base: BaseRecommendClient
 ) => WithRecommendMethods<BaseRecommendClient>['getTrendingGlobalItems'];
 
 export const getTrendingGlobalItems: GetTrendingGlobalItems = base => {
   return (queries: readonly TrendingGlobalItemsQuery[], requestOptions) => {
-    return getRecommendations(base)(
-      queries.map(query => ({
-        ...query,
-        model: 'trending-items',
-      })),
+    const requests: readonly TrendingGlobalItemsQuery[] = queries.map(query => ({
+      ...query,
+      model: 'trending-items',
+      // 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
+      // so that users don't have to provide a value.
+      threshold: query.threshold || 0,
+    }));
+
+    return base.transporter.read(
+      {
+        method: MethodEnum.Post,
+        path: '1/indexes/*/recommendations',
+        data: {
+          requests,
+        },
+        cacheable: true,
+      },
       requestOptions
     );
   };

packages/recommend/src/methods/getTrendingItemsForFacet.ts

@@ -1,16 +1,15 @@
 import { BaseRecommendClient, TrendingItemsForFacetQuery, WithRecommendMethods } from '../types';
-import { getRecommendations } from './getRecommendations';
+import { getTrendingGlobalItems } from '.';
 
 type GetTrendingItemsForFacet = (
   base: BaseRecommendClient
 ) => WithRecommendMethods<BaseRecommendClient>['getTrendingItemsForFacet'];
 
 export const getTrendingItemsForFacet: GetTrendingItemsForFacet = base => {
   return (queries: readonly TrendingItemsForFacetQuery[], requestOptions) => {
-    return getRecommendations(base)(
+    return getTrendingGlobalItems(base)(
       queries.map(query => ({
         ...query,
-        model: 'trending-items',
       })),
       requestOptions
     );

packages/recommend/src/types/FrequentlyBoughtTogetherQuery.ts

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

packages/recommend/src/types/RecommendModel.ts

@@ -1,5 +1,2 @@
-export type RecommendModel =
-  | 'related-products'
-  | 'bought-together'
-  | 'trending-items'
-  | 'trending-facets';
+export type RecommendModel = 'related-products' | 'bought-together';
+export type TrendingModel = 'trending-items' | 'trending-facets';

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,3 +1,3 @@
 import { RecommendationsQuery } from './RecommendationsQuery';
 
-export type RelatedProductsQuery = Omit<RecommendationsQuery, 'model' | 'facetName' | 'facetValue'>;
+export type RelatedProductsQuery = Omit<RecommendationsQuery, 'model'>;

packages/recommend/src/types/TrendingFacetsQuery.ts

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

packages/recommend/src/types/TrendingGlobalItemsQuery.ts

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

packages/recommend/src/types/TrendingItemsForFacetQuery.ts

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

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

@@ -13,4 +13,5 @@ export * from './RelatedProductsQuery';
 export * from './TrendingFacetsQuery';
 export * from './TrendingGlobalItemsQuery';
 export * from './TrendingItemsForFacetQuery';
+export * from './TrendingQuery';
 export * from './WithRecommendMethods';