Add facets to the intsch client

Author: salesfelipe

node/clients/intelligent-search-api.ts

@@ -29,7 +29,7 @@ interface AutocompleteSearchSuggestionsParams {
   query: string
 }
 
-interface FacetsArgs {
+export type FacetsArgs = {
   query?: string
   page?: number
   count?: number

node/clients/intsch/index.ts

@@ -8,6 +8,7 @@ import type {
   CorrectionArgs,
   CorrectionArgsV1,
   CorrectionResponse,
+  FacetsResponse,
   FetchBannersArgs,
   FetchBannersArgsV1,
   FetchBannersResponse,
@@ -21,6 +22,7 @@ import type {
   TopSearchesResponse,
 } from './types'
 import type { SearchResultArgs } from '../../typings/Search'
+import type { FacetsArgs } from '../intelligent-search-api'
 import { decodeQuery, isPathTraversal } from '../intelligent-search-api'
 import { parseState } from '../../utils/searchState'
 
@@ -163,4 +165,30 @@ export class Intsch extends JanusClient implements IIntelligentSearchClient {
       },
     })
   }
+
+  public facets(
+    params: FacetsArgs,
+    path: string,
+    shippingHeader?: string[]
+  ): Promise<FacetsResponse> {
+    if (isPathTraversal(path)) {
+      throw new Error('Malformed URL')
+    }
+
+    const { query, leap, searchState } = params
+
+    return this.http.get(`/api/intelligent-search/v0/facets/${path}`, {
+      params: {
+        ...params,
+        query: query && decodeQuery(query),
+        locale: this.locale,
+        bgy_leap: leap ? true : undefined,
+        ...parseState(searchState),
+      },
+      metric: 'facets-new',
+      headers: {
+        'x-vtex-shipping-options': shippingHeader ?? '',
+      },
+    })
+  }
 }

node/clients/intsch/types.ts

@@ -1,4 +1,5 @@
 import type { SearchResultArgs } from '../../typings/Search'
+import type { FacetsArgs } from '../intelligent-search-api'
 
 export type AutocompleteSuggestionsArgs = {
   query: string
@@ -97,6 +98,8 @@ export type ProductSearchResponse = {
   products: SearchProduct[]
 }
 
+export type FacetsResponse = any
+
 export interface IIntelligentSearchClient {
   fetchAutocompleteSuggestions(
     args: AutocompleteSuggestionsArgs
@@ -122,4 +125,9 @@ export interface IIntelligentSearchClient {
     path: string,
     shippingHeader?: string[]
   ): Promise<ProductSearchResponse>
+  facets(
+    params: FacetsArgs,
+    path: string,
+    shippingHeader?: string[]
+  ): Promise<FacetsResponse>
 }

node/mocks/intsch.ts

@@ -6,6 +6,8 @@ import type {
   CorrectionResponse,
   FetchBannersResponse,
   FetchProductResponse,
+  ProductSearchResponse,
+  FacetsResponse,
 } from '../clients/intsch/types'
 
 export class MockedIntschClient implements IIntelligentSearchClient {
@@ -91,6 +93,18 @@ export class MockedIntschClient implements IIntelligentSearchClient {
     } else {
       this.fetchBannersV1.mockResolvedValue(args?.fetchBannersV1 ?? null)
     }
+
+    if (args?.productSearch instanceof Error) {
+      this.productSearch.mockRejectedValue(args.productSearch)
+    } else {
+      this.productSearch.mockResolvedValue(args?.productSearch ?? null)
+    }
+
+    if (args?.facets instanceof Error) {
+      this.facets.mockRejectedValue(args.facets)
+    } else {
+      this.facets.mockResolvedValue(args?.facets ?? null)
+    }
   }
 
   public fetchAutocompleteSuggestions = jest.fn()
@@ -104,6 +118,8 @@ export class MockedIntschClient implements IIntelligentSearchClient {
   public fetchSearchSuggestionsV1 = jest.fn()
   public fetchCorrectionV1 = jest.fn()
   public fetchBannersV1 = jest.fn()
+  public productSearch = jest.fn()
+  public facets = jest.fn()
 }
 
 export type IntelligentSearchClientArgs = {
@@ -118,4 +134,6 @@ export type IntelligentSearchClientArgs = {
   fetchSearchSuggestionsV1?: SearchSuggestionsResponse | Error
   fetchCorrectionV1?: CorrectionResponse | Error
   fetchBannersV1?: FetchBannersResponse | Error
+  productSearch?: ProductSearchResponse | Error
+  facets?: FacetsResponse | Error
 }