Support facetAllowlist query parameter for vertical searches

docs/search-core.verticalsearchrequest.facetallowlist.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [VerticalSearchRequest](./search-core.verticalsearchrequest.md) &gt; [facetAllowlist](./search-core.verticalsearchrequest.facetallowlist.md)
+
+## VerticalSearchRequest.facetAllowlist property
+
+A subset of facet field IDs that facet options will be retrieved for.
+
+**Signature:**
+
+```typescript
+facetAllowlist?: string[];
+```

docs/search-core.verticalsearchrequest.md

@@ -54,6 +54,25 @@ Description
 _(Optional)_ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/)<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[facetAllowlist?](./search-core.verticalsearchrequest.facetallowlist.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ A subset of facet field IDs that facet options will be retrieved for.
+
+
 </td></tr>
 <tr><td>
 

etc/search-core.api.md

@@ -880,6 +880,7 @@ export interface VerticalResults {
 // @public
 export interface VerticalSearchRequest extends SearchRequest {
     context?: Context;
+    facetAllowlist?: string[];
     facets?: Facet[];
     limit?: number;
     location?: LatLong;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/search-core",
-  "version": "2.6.3",
+  "version": "2.6.4",
   "description": "Typescript Networking Library for the Yext Search API",
   "main": "./dist/commonjs/src/index.js",
   "module": "./dist/esm/src/index.js",

src/infra/SearchServiceImpl.ts

@@ -69,7 +69,8 @@ interface VerticalSearchQueryParams extends QueryParams {
   source?: QuerySource | string,
   locationRadius?: string,
   queryId?: string,
-  visitor?: string
+  visitor?: string,
+  facetAllowlist?: string
 }
 
 /**
@@ -167,6 +168,7 @@ export class SearchServiceImpl implements SearchService {
       queryId: request.queryId,
       visitorId: this.config.visitor?.id,
       visitorIdMethod: this.config.visitor?.idMethod,
+      facetAllowlist: request.facetAllowlist?.join(','),
       ...this.config?.additionalQueryParams
     };
 
@@ -200,4 +202,4 @@ export class SearchServiceImpl implements SearchService {
     }
     return `${latLong.latitude},${latLong.longitude}`;
   }
-}
+}

src/models/searchservice/request/VerticalSearchRequest.ts

@@ -48,5 +48,7 @@ export interface VerticalSearchRequest extends SearchRequest {
   /** The radius (in meters) to filter the vertical search by. */
   locationRadius?: number,
   /** The queryId for the query, if this is a repeat query. */
-  queryId?: string
-}
+  queryId?: string,
+  /** A subset of facet field IDs that facet options will be retrieved for. */
+  facetAllowlist?: string[]
+}

test-site/index.html

@@ -15,5 +15,6 @@
     <button onclick="filterSearch()">Filter Search</button>
     <button onclick="generativeDirectAnswer()">Generative Direct Answer</button>
     <button onclick="functionVerticalSearch()">Function Vertical Search</button>
+    <button onclick="locationsVerticalSearch()">Locations Vertical Search</button>
   </body>
 </html>

test-site/src/js/index.js

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 import { provideCore } from '@yext/search-core';
-import { verticalRequest, functionVerticalRequest } from './requests/verticalRequest';
+import { verticalRequest, functionVerticalRequest, locationsVerticalRequest } from './requests/verticalRequest';
 import universalRequest from './requests/universalRequest';
 import questionRequest from './requests/questionRequest';
 import { univeralAutocompleteRequest, verticalAutocompleteRequest, filterSearchRequest } from './requests/autocompleteRequests';
@@ -76,6 +76,13 @@ export async function functionVerticalSearch() {
   updateUI(results, startTime, 'Core Function Vertical Response:');
 }
 
+export async function locationsVerticalSearch() {
+  loadingSpinner();
+  const startTime = new Date().getTime();
+  const results = await globalCore.verticalSearch(locationsVerticalRequest);
+  updateUI(results, startTime, 'Locations Vertical Response:');
+}
+
 function loadingSpinner() {
   element.textContent = 'Loading...';
 }

test-site/src/js/requests/verticalRequest.js

@@ -12,7 +12,14 @@ export const verticalRequest = {
   referrerPageUrl: 'www.google.com/answers/not/ads'
 };
 
+export const locationsVerticalRequest = {
+  verticalKey: 'KM',
+  query: 'virginia',
+  retrieveFacets: true,
+  facetAllowlist: ['address.city', 'services']
+};
+
 export const functionVerticalRequest = {
   verticalKey: 'function_vertical',
   query: 'virginia',
-};
+};

test-site/src/ts/index.ts

@@ -1,5 +1,9 @@
 import { provideCore, SearchConfig, SearchCore, UniversalSearchRequest, UniversalSearchResponse } from '@yext/search-core';
-import { verticalRequest, functionVerticalRequest } from './requests/verticalRequest';
+import {
+  verticalRequest,
+  functionVerticalRequest,
+  locationsVerticalRequest
+} from './requests/verticalRequest';
 import universalRequest from './requests/universalRequest';
 import questionRequest from './requests/questionRequest';
 import { univeralAutocompleteRequest, verticalAutocompleteRequest, filterSearchRequest } from './requests/autocompleteRequests';
@@ -51,6 +55,13 @@ export async function functionVerticalSearch(): Promise<void> {
   updateUI(results, startTime, 'Core Function Vertical Response:');
 }
 
+export async function locationsVerticalSearch(): Promise<void> {
+  loadingSpinner();
+  const startTime = new Date().getTime();
+  const results = await globalCore.verticalSearch(locationsVerticalRequest);
+  updateUI(results, startTime, 'Locations Vertical Response:');
+}
+
 export async function submitQuestion(): Promise<void> {
   loadingSpinner();
   const startTime = new Date().getTime();

test-site/src/ts/requests/verticalRequest.ts

@@ -17,7 +17,14 @@ export const verticalRequest: VerticalSearchRequest = {
   }
 };
 
+export const locationsVerticalRequest: VerticalSearchRequest = {
+  verticalKey: 'KM',
+  query: 'virginia',
+  retrieveFacets: true,
+  facetAllowlist: ['address.city', 'services']
+};
+
 export const functionVerticalRequest: VerticalSearchRequest = {
   verticalKey: 'function_vertical',
   query: 'virginia',
-};
+};