fix(recommend): update trending facets query props (RECO-1184) (#1434)

* fix: update trending facets query props
* fix: add more descriptive docs for parameters

Author: marialungu

packages/recommend/src/methods/getRecommendations.ts

@@ -3,14 +3,20 @@ import { MethodEnum } from '@algolia/requester-common';
 import{
 BaseRecommendClient,
 RecommendationsQuery,
-TrendingQuery,
+TrendingFacetsQuery,
+TrendingItemsQuery,
+TrendingModel,
 WithRecommendMethods,
 }from'../types';
 
 typeGetRecommendations=(
 base: BaseRecommendClient
 )=>WithRecommendMethods<BaseRecommendClient>['getRecommendations'];
 
+typeTrendingQuery=
+|(TrendingItemsQuery&{readonlymodel: TrendingModel})
+|(TrendingFacetsQuery&{readonlymodel: TrendingModel});
+
 exportconstgetRecommendations: GetRecommendations=base=>{
 return(queries: ReadonlyArray<RecommendationsQuery|TrendingQuery>,requestOptions)=>{
 constrequests: ReadonlyArray<RecommendationsQuery|TrendingQuery>=queries.map(query=>({

packages/recommend/src/types/TrendingFacetsQuery.ts

@@ -1,6 +1,21 @@
-import{TrendingQuery}from'./TrendingQuery';
+exporttypeTrendingFacetsQuery={
+/**
+ * The name of the target index.
+ */
+readonlyindexName: string;
 
-exporttypeTrendingFacetsQuery=Omit<
-TrendingQuery,
-'model'|'facetValue'|'fallbackParameters'|'queryParameters'
->;
+/**
+ * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
+ */
+readonlythreshold?: number;
+
+/**
+ * How many recommendations to retrieve.
+ */
+readonlymaxRecommendations?: number;
+
+/**
+ * The facet attribute to get recommendations for.
+ */
+readonlyfacetName: string;
+};

packages/recommend/src/types/TrendingItemsQuery.ts

@@ -1,3 +1,40 @@
-import{TrendingQuery}from'./TrendingQuery';
+import{RecommendSearchOptions}from'@algolia/recommend';
 
-exporttypeTrendingItemsQuery=Omit<TrendingQuery,'model'>;
+exporttypeTrendingItemsQuery={
+/**
+ * The name of the target index.
+ */
+readonlyindexName: string;
+
+/**
+ * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
+ */
+readonlythreshold?: number;
+
+/**
+ * How many recommendations to retrieve.
+ */
+readonlymaxRecommendations?: number;
+
+/**
+ * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
+ */
+readonlyqueryParameters?: 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.
+ */
+readonlyfallbackParameters?: RecommendSearchOptions;
+
+/**
+ * The facet attribute to get recommendations for.
+ */
+readonlyfacetName?: string;
+
+/**
+ * The value of the target facet.
+ */
+readonlyfacetValue?: string;
+};

packages/recommend/src/types/TrendingQuery.ts

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