Merge branch 'master' into feat-recommended-for-you

algolia · Dec 7, 2023 · 08f12ee · 08f12ee
2 parents 071f2a8 + 94b46b5
commit 08f12ee
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 1 deletion.
diff --git a/packages/recommend/src/types/TrendingFacetHit.ts b/packages/recommend/src/types/TrendingFacetHit.ts
@@ -0,0 +1,5 @@
+export type TrendingFacetHit<TObject> = {
+  readonly _score: number;
+  readonly facetName: string;
+  readonly facetValue: TObject;
+};
diff --git a/packages/recommend/src/types/TrendingFacetsResponse.ts b/packages/recommend/src/types/TrendingFacetsResponse.ts
@@ -0,0 +1,7 @@
+import { SearchResponse } from '@algolia/client-search';
+
+import { TrendingFacetHit } from './TrendingFacetHit';
+
+export type TrendingFacetsResponse<TObject> = Omit<SearchResponse<TObject>, 'hits'> & {
+  readonly hits: ReadonlyArray<TrendingFacetHit<TObject>>;
+};
diff --git a/packages/recommend/src/types/WithRecommendMethods.ts b/packages/recommend/src/types/WithRecommendMethods.ts
@@ -7,9 +7,17 @@ import { LookingSimilarQuery } from './LookingSimilarQuery';
 import { RecommendationsQuery } from './RecommendationsQuery';
 import { RelatedProductsQuery } from './RelatedProductsQuery';
 import { TrendingFacetsQuery } from './TrendingFacetsQuery';
+import { TrendingFacetsResponse } from './TrendingFacetsResponse';
 import { TrendingItemsQuery } from './TrendingItemsQuery';
 import { TrendingQuery } from './TrendingQuery';
 
+export type RecommendTrendingFacetsQueriesResponse<TObject> = {
+  /**
+   * The list of results.
+   */
+  readonly results: ReadonlyArray<TrendingFacetsResponse<TObject>>;
+};
+
 export type RecommendQueriesResponse<TObject> = {
   /**
    * The list of results.
@@ -56,7 +64,7 @@ export type WithRecommendMethods<TType> = TType & {
   readonly getTrendingFacets: <TObject>(
     queries: readonly TrendingFacetsQuery[],
     requestOptions?: RequestOptions & SearchOptions
-  ) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
+  ) => Readonly<Promise<RecommendTrendingFacetsQueriesResponse<TObject>>>;
 
   /**
    * Returns Looking Similar

diff --git a/packages/recommend/src/types/index.ts b/packages/recommend/src/types/index.ts
@@ -16,3 +16,5 @@ export * from './TrendingQuery';
 export * from './WithRecommendMethods';
 export * from './LookingSimilarQuery';
 export * from './RecommendedForYouQuery';
+export * from './TrendingFacetHit';
+export * from './TrendingFacetsResponse';