feat(recommend): add "Looking Similar" model (#1469)

* feat(recommend): add Looking Similar model --------- Co-authored-by: Dhaya <154633+dhayab@users.noreply.github.com>
algolia · Jul 18, 2023 · 01eac7f · 01eac7f
1 parent b88a726
commit 01eac7f
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 1 deletion.
diff --git a/packages/recommend/src/builds/browser.ts b/packages/recommend/src/builds/browser.ts
@@ -10,6 +10,7 @@ import { createUserAgent } from '@algolia/transporter';
 import { createRecommendClient } from '../createRecommendClient';
 import {
   getFrequentlyBoughtTogether,
+  getLookingSimilar,
   getRecommendations,
   getRelatedProducts,
   getTrendingFacets,
@@ -55,6 +56,7 @@ export default function recommend(
       getRelatedProducts,
       getTrendingFacets,
       getTrendingItems,
+      getLookingSimilar,
     },
   });
 }

diff --git a/packages/recommend/src/builds/node.ts b/packages/recommend/src/builds/node.ts
@@ -9,6 +9,7 @@ import { createUserAgent } from '@algolia/transporter';
 import { createRecommendClient } from '../createRecommendClient';
 import {
   getFrequentlyBoughtTogether,
+  getLookingSimilar,
   getRecommendations,
   getRelatedProducts,
   getTrendingFacets,
@@ -49,6 +50,7 @@ export default function recommend(
       getRelatedProducts,
       getTrendingFacets,
       getTrendingItems,
+      getLookingSimilar,
     },
   });
 }

diff --git a/packages/recommend/src/methods/getLookingSimilar.ts b/packages/recommend/src/methods/getLookingSimilar.ts
@@ -0,0 +1,18 @@
+import { BaseRecommendClient, LookingSimilarQuery, WithRecommendMethods } from '../types';
+import { getRecommendations } from './getRecommendations';
+
+type GetLookingSimilar = (
+  base: BaseRecommendClient
+) => WithRecommendMethods<BaseRecommendClient>['getLookingSimilar'];
+
+export const getLookingSimilar: GetLookingSimilar = base => {
+  return (queries: readonly LookingSimilarQuery[], requestOptions) => {
+    return getRecommendations(base)(
+      queries.map(query => ({
+        ...query,
+        model: 'looking-similar',
+      })),
+      requestOptions
+    );
+  };
+};
diff --git a/packages/recommend/src/methods/index.ts b/packages/recommend/src/methods/index.ts
@@ -7,3 +7,4 @@ export * from './getRecommendations';
 export * from './getRelatedProducts';
 export * from './getTrendingFacets';
 export * from './getTrendingItems';
+export * from './getLookingSimilar';
diff --git a/packages/recommend/src/types/LookingSimilarQuery.ts b/packages/recommend/src/types/LookingSimilarQuery.ts
@@ -0,0 +1,3 @@
+import { RecommendationsQuery } from './RecommendationsQuery';
+
+export type LookingSimilarQuery = Omit<RecommendationsQuery, 'model'>;
diff --git a/packages/recommend/src/types/RecommendModel.ts b/packages/recommend/src/types/RecommendModel.ts
@@ -1,2 +1,6 @@
 export type TrendingModel = 'trending-items' | 'trending-facets';
-export type RecommendModel = 'related-products' | 'bought-together' | TrendingModel;
+export type RecommendModel =
+  | 'related-products'
+  | 'bought-together'
+  | 'looking-similar'
+  | TrendingModel;
diff --git a/packages/recommend/src/types/WithRecommendMethods.ts b/packages/recommend/src/types/WithRecommendMethods.ts
@@ -2,6 +2,7 @@ import { MultipleQueriesResponse, SearchOptions } from '@algolia/client-search';
 import { RequestOptions } from '@algolia/transporter';
 
 import { FrequentlyBoughtTogetherQuery } from './FrequentlyBoughtTogetherQuery';
+import { LookingSimilarQuery } from './LookingSimilarQuery';
 import { RecommendationsQuery } from './RecommendationsQuery';
 import { RelatedProductsQuery } from './RelatedProductsQuery';
 import { TrendingFacetsQuery } from './TrendingFacetsQuery';
@@ -48,4 +49,12 @@ export type WithRecommendMethods<TType> = TType & {
     queries: readonly TrendingFacetsQuery[],
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
+
+  /**
+   * Returns Looking Similar
+   */
+  readonly getLookingSimilar: <TObject>(
+    queries: readonly LookingSimilarQuery[],
+    requestOptions?: RequestOptions & SearchOptions
+  ) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
 };
diff --git a/packages/recommend/src/types/index.ts b/packages/recommend/src/types/index.ts
@@ -14,3 +14,4 @@ export * from './TrendingFacetsQuery';
 export * from './TrendingItemsQuery';
 export * from './TrendingQuery';
 export * from './WithRecommendMethods';
+export * from './LookingSimilarQuery';