Version 1.3 (#99)

### Features - Direct answers are now supported on vertical searches (#96) - For universal searches, a limit for each vertical can now be supplied (#90) (#93) - A session ID can now be supplied for vertical and universal searches (#94) - A query source can now be an arbitrary string for vertical and universal searches (#95) ### Enhancements - Question submissions are now sent to a new endpoint with higher availability (#98) ### Bugfixes - Fixes a bug which caused cookies to not be sent properly (#97)
yext · Aug 24, 2021 · 98f272c · 98f272c
2 parents 19c773d + 67a3601
commit 98f272c
Show file tree

Hide file tree

Showing 32 changed files with 251 additions and 101 deletions.
diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES
@@ -59,7 +59,7 @@ THE SOFTWARE.
 
 The following NPM packages may be included in this product:
 
- - cross-fetch@3.0.6
+ - cross-fetch@3.1.4
 
 These packages each contain the following license and notice below:
 

diff --git a/api-extractor.json b/api-extractor.json
@@ -221,7 +221,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: ""
      */
-     "publicTrimmedFilePath": "<projectFolder>/dist/bundle.d.ts"
+    "publicTrimmedFilePath": "<projectFolder>/dist/bundle.d.ts"
 
     /**
      * When a declaration is trimmed, by default it will be replaced by a code comment such as

diff --git a/docs/answers-core.md b/docs/answers-core.md
@@ -65,6 +65,7 @@
 |  [SortBy](./answers-core.sortby.md) | Represents a criterion that can be used to sort results. |
 |  [SpellCheck](./answers-core.spellcheck.md) | A spellcheck response from a search query. |
 |  [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) | Options for a universal autocomplete request. |
+|  [UniversalLimit](./answers-core.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. |
 |  [UniversalSearchRequest](./answers-core.universalsearchrequest.md) | Options which can be specified for a universal search. |
 |  [UniversalSearchResponse](./answers-core.universalsearchresponse.md) | A representation of a response from a universal search. |
 |  [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) | Options for a vertial autocomplete request. |

diff --git a/docs/answers-core.universallimit.md b/docs/answers-core.universallimit.md
@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [UniversalLimit](./answers-core.universallimit.md)
+
+## UniversalLimit interface
+
+The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive.
+
+<b>Signature:</b>
+
+```typescript
+export interface UniversalLimit 
+```
+
+## Example
+
+{ people: 5, locations: 10, events: 8 }
+
diff --git a/docs/answers-core.universalsearchrequest.limit.md b/docs/answers-core.universalsearchrequest.limit.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [UniversalSearchRequest](./answers-core.universalsearchrequest.md) &gt; [limit](./answers-core.universalsearchrequest.limit.md)
+
+## UniversalSearchRequest.limit property
+
+The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive.
+
+<b>Signature:</b>
+
+```typescript
+limit?: UniversalLimit;
+```
diff --git a/docs/answers-core.universalsearchrequest.md b/docs/answers-core.universalsearchrequest.md
@@ -17,11 +17,13 @@ export interface UniversalSearchRequest
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [context?](./answers-core.universalsearchrequest.context.md) | [Context](./answers-core.context.md) | <i>(Optional)</i> Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/)<!-- -->. |
+|  [limit?](./answers-core.universalsearchrequest.limit.md) | [UniversalLimit](./answers-core.universallimit.md) | <i>(Optional)</i> The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. |
 |  [location?](./answers-core.universalsearchrequest.location.md) | [LatLong](./answers-core.latlong.md) | <i>(Optional)</i> The latitude and longitude of the user making the request. Used to bias the results. |
 |  [query](./answers-core.universalsearchrequest.query.md) | string | The search query. |
-|  [querySource?](./answers-core.universalsearchrequest.querysource.md) | [QuerySource](./answers-core.querysource.md) | <i>(Optional)</i> The source of the search request. |
+|  [querySource?](./answers-core.universalsearchrequest.querysource.md) | [QuerySource](./answers-core.querysource.md) \| string | <i>(Optional)</i> The source of the search request. |
 |  [queryTrigger?](./answers-core.universalsearchrequest.querytrigger.md) | [QueryTrigger](./answers-core.querytrigger.md) | <i>(Optional)</i> Describes the ways a search can be executed besides user input. |
 |  [referrerPageUrl?](./answers-core.universalsearchrequest.referrerpageurl.md) | string | <i>(Optional)</i> The URl of the page which referred the user to the current page. |
+|  [sessionId?](./answers-core.universalsearchrequest.sessionid.md) | string | <i>(Optional)</i> Used to track session state when cookies are blocked. |
 |  [sessionTrackingEnabled?](./answers-core.universalsearchrequest.sessiontrackingenabled.md) | boolean | <i>(Optional)</i> Enables session tracking. |
 |  [skipSpellCheck?](./answers-core.universalsearchrequest.skipspellcheck.md) | boolean | <i>(Optional)</i> Disables spellcheck if true. |
 
diff --git a/docs/answers-core.universalsearchrequest.querysource.md b/docs/answers-core.universalsearchrequest.querysource.md
@@ -9,5 +9,5 @@ The source of the search request.
 <b>Signature:</b>
 
 ```typescript
-querySource?: QuerySource;
+querySource?: QuerySource | string;
 ```
diff --git a/docs/answers-core.universalsearchrequest.sessionid.md b/docs/answers-core.universalsearchrequest.sessionid.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [UniversalSearchRequest](./answers-core.universalsearchrequest.md) &gt; [sessionId](./answers-core.universalsearchrequest.sessionid.md)
+
+## UniversalSearchRequest.sessionId property
+
+Used to track session state when cookies are blocked.
+
+<b>Signature:</b>
+
+```typescript
+sessionId?: string;
+```
diff --git a/docs/answers-core.verticalsearchrequest.md b/docs/answers-core.verticalsearchrequest.md
@@ -24,10 +24,11 @@ export interface VerticalSearchRequest
 |  [offset?](./answers-core.verticalsearchrequest.offset.md) | number | <i>(Optional)</i> The result offset which allows for fetching more results with the same query. |
 |  [query](./answers-core.verticalsearchrequest.query.md) | string | The search query. |
 |  [queryId?](./answers-core.verticalsearchrequest.queryid.md) | string | <i>(Optional)</i> The queryId for the query, if this is a repeat query. |
-|  [querySource?](./answers-core.verticalsearchrequest.querysource.md) | [QuerySource](./answers-core.querysource.md) | <i>(Optional)</i> The source of the search request. |
+|  [querySource?](./answers-core.verticalsearchrequest.querysource.md) | [QuerySource](./answers-core.querysource.md) \| string | <i>(Optional)</i> The source of the search request. |
 |  [queryTrigger?](./answers-core.verticalsearchrequest.querytrigger.md) | [QueryTrigger](./answers-core.querytrigger.md) | <i>(Optional)</i> Describes the ways a search can be executed besides user input. |
 |  [referrerPageUrl?](./answers-core.verticalsearchrequest.referrerpageurl.md) | string | <i>(Optional)</i> The URl of the page which referred the user to the current page. |
 |  [retrieveFacets?](./answers-core.verticalsearchrequest.retrievefacets.md) | boolean | <i>(Optional)</i> Indicates that facets should be retrieved. |
+|  [sessionId?](./answers-core.verticalsearchrequest.sessionid.md) | string | <i>(Optional)</i> Used to track session state when cookies are blocked. |
 |  [sessionTrackingEnabled?](./answers-core.verticalsearchrequest.sessiontrackingenabled.md) | boolean | <i>(Optional)</i> Enables session tracking. |
 |  [skipSpellCheck?](./answers-core.verticalsearchrequest.skipspellcheck.md) | boolean | <i>(Optional)</i> Skips spell checking if true. |
 |  [sortBys?](./answers-core.verticalsearchrequest.sortbys.md) | [SortBy](./answers-core.sortby.md)<!-- -->\[\] | <i>(Optional)</i> Determines how results are sorted. \* |

diff --git a/docs/answers-core.verticalsearchrequest.querysource.md b/docs/answers-core.verticalsearchrequest.querysource.md
@@ -9,5 +9,5 @@ The source of the search request.
 <b>Signature:</b>
 
 ```typescript
-querySource?: QuerySource;
+querySource?: QuerySource | string;
 ```
diff --git a/docs/answers-core.verticalsearchrequest.sessionid.md b/docs/answers-core.verticalsearchrequest.sessionid.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) &gt; [sessionId](./answers-core.verticalsearchrequest.sessionid.md)
+
+## VerticalSearchRequest.sessionId property
+
+Used to track session state when cookies are blocked.
+
+<b>Signature:</b>
+
+```typescript
+sessionId?: string;
+```
diff --git a/docs/answers-core.verticalsearchresponse.directanswer.md b/docs/answers-core.verticalsearchresponse.directanswer.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) &gt; [directAnswer](./answers-core.verticalsearchresponse.directanswer.md)
+
+## VerticalSearchResponse.directAnswer property
+
+A direct answer to a search.
+
+<b>Signature:</b>
+
+```typescript
+directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer;
+```
diff --git a/docs/answers-core.verticalsearchresponse.md b/docs/answers-core.verticalsearchresponse.md
@@ -18,6 +18,7 @@ export interface VerticalSearchResponse
 |  --- | --- | --- |
 |  [allResultsForVertical?](./answers-core.verticalsearchresponse.allresultsforvertical.md) | [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) | <i>(Optional)</i> A representation of a response from a vertical search. |
 |  [alternativeVerticals?](./answers-core.verticalsearchresponse.alternativeverticals.md) | [VerticalResults](./answers-core.verticalresults.md)<!-- -->\[\] | <i>(Optional)</i> The [VerticalResults](./answers-core.verticalresults.md) for each search vertical. |
+|  [directAnswer?](./answers-core.verticalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) | <i>(Optional)</i> A direct answer to a search. |
 |  [facets?](./answers-core.verticalsearchresponse.facets.md) | [DisplayableFacet](./answers-core.displayablefacet.md)<!-- -->\[\] | <i>(Optional)</i> An array of [Facet](./answers-core.facet.md)<!-- -->s associated with the search results. |
 |  [locationBias?](./answers-core.verticalsearchresponse.locationbias.md) | [LocationBias](./answers-core.locationbias.md) | <i>(Optional)</i> Information about the user's location. |
 |  [queryId](./answers-core.verticalsearchresponse.queryid.md) | string | The ID of the query. |

diff --git a/etc/answers-core.api.md b/etc/answers-core.api.md
@@ -365,14 +365,22 @@ export interface UniversalAutocompleteRequest {
     sessionTrackingEnabled?: boolean;
 }
 
+// @public
+export interface UniversalLimit {
+    // (undocumented)
+    [verticalKey: string]: number;
+}
+
 // @public
 export interface UniversalSearchRequest {
     context?: Context;
+    limit?: UniversalLimit;
     location?: LatLong;
     query: string;
-    querySource?: QuerySource;
+    querySource?: QuerySource | string;
     queryTrigger?: QueryTrigger;
     referrerPageUrl?: string;
+    sessionId?: string;
     sessionTrackingEnabled?: boolean;
     skipSpellCheck?: boolean;
 }
@@ -415,10 +423,11 @@ export interface VerticalSearchRequest {
     offset?: number;
     query: string;
     queryId?: string;
-    querySource?: QuerySource;
+    querySource?: QuerySource | string;
     queryTrigger?: QueryTrigger;
     referrerPageUrl?: string;
     retrieveFacets?: boolean;
+    sessionId?: string;
     sessionTrackingEnabled?: boolean;
     skipSpellCheck?: boolean;
     sortBys?: SortBy[];
@@ -430,6 +439,7 @@ export interface VerticalSearchRequest {
 export interface VerticalSearchResponse {
     allResultsForVertical?: VerticalSearchResponse;
     alternativeVerticals?: VerticalResults[];
+    directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer;
     facets?: DisplayableFacet[];
     locationBias?: LocationBias;
     queryId: string;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@yext/answers-core",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Typescript Networking Library for the Yext Answers API",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/esm/index.js",
@@ -54,15 +54,14 @@
     "eslint": "^7.11.0",
     "generate-license-file": "^1.1.0",
     "jest": "^26.6.0",
-    "jest-fetch-mock": "^3.0.3",
     "ts-loader": "^8.0.14",
     "typescript": "^4.0.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.12.5",
-    "cross-fetch": "^3.0.6"
+    "cross-fetch": "^3.1.4"
   },
   "jest": {
     "bail": 0,
@@ -74,15 +73,11 @@
       "js",
       "ts"
     ],
-    "setupFilesAfterEnv": [
-      "./tests/setup/setup.js"
-    ],
     "moduleDirectories": [
       "node_modules",
       "<rootDir>"
     ],
     "testPathIgnorePatterns": [
-      "./tests/setup/setup.js",
       "./tests/mocks/*"
     ],
     "testMatch": [

diff --git a/src/constants.ts b/src/constants.ts
@@ -5,7 +5,7 @@ export const defaultApiVersion = 20190101;
 export const defaultEndpoints: Required<Endpoints> = {
   universalSearch: 'https://liveapi.yext.com/v2/accounts/me/answers/query',
   verticalSearch: 'https://liveapi.yext.com/v2/accounts/me/answers/vertical/query',
-  questionSubmission: 'https://api.yext.com/v2/accounts/me/createQuestion',
+  questionSubmission: 'https://liveapi.yext.com/v2/accounts/me/createQuestion',
   status: 'https://answersstatus.pagescdn.com',
   universalAutocomplete: 'https://liveapi-cached.yext.com/v2/accounts/me/answers/autocomplete',
   verticalAutocomplete: 'https://liveapi-cached.yext.com/v2/accounts/me/answers/vertical/autocomplete',

diff --git a/src/infra/HttpServiceImpl.ts b/src/infra/HttpServiceImpl.ts
@@ -1,4 +1,4 @@
-import fetch from 'cross-fetch';
+import crossFetch from 'cross-fetch';
 import { addParamsToURL, sanitizeQueryParams } from '../utils/urlutils';
 import { QueryParams } from '../models/http/params';
 import { HttpService } from '../services/HttpService';
@@ -22,14 +22,11 @@ export class HttpServiceImpl implements HttpService {
   get<T>(
     url: string,
     queryParams: QueryParams,
-    options?: RequestInit,
   ): Promise<T> {
-    const reqInitWithMethod = {
+    return this.fetch(url, queryParams, {
       method: RequestMethods.GET,
-      ...options
-    };
-    return this.fetch(url, queryParams, reqInitWithMethod)
-      .then(res => res.json());
+      credentials: 'include'
+    }).then(res => res.json());
   }
 
   /**
@@ -38,16 +35,17 @@ export class HttpServiceImpl implements HttpService {
   post<T>(
     url: string,
     queryParams: QueryParams,
-    body: QueryParams,
-    reqInit: RequestInit
+    body: QueryParams
   ): Promise<T> {
     const sanitizedBodyParams = sanitizeQueryParams(body);
-    const reqInitWithMethodAndBody = {
+    return this.fetch(url, queryParams, {
       method: RequestMethods.POST,
       body: JSON.stringify(sanitizedBodyParams),
-      ...reqInit
-    };
-    return this.fetch(url, queryParams, reqInitWithMethodAndBody)
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    })
       .then(res => res.json());
   }
 
@@ -60,6 +58,9 @@ export class HttpServiceImpl implements HttpService {
     reqInit: RequestInit
   ): Promise<Response> {
     const urlWithParams = addParamsToURL(url, queryParams);
-    return fetch(urlWithParams, reqInit);
+    if (window.fetch) {
+      return window.fetch(urlWithParams, reqInit);
+    }
+    return crossFetch(urlWithParams, reqInit);
   }
 }
diff --git a/src/infra/QuestionSubmissionServiceImpl.ts b/src/infra/QuestionSubmissionServiceImpl.ts
@@ -48,18 +48,10 @@ export class QuestionSubmissionServiceImpl implements QuestionSubmissionService
       site: 'FIRSTPARTY'
     };
 
-    const requestInit = {
-      mode: 'cors' as RequestMode,
-      headers: {
-        'Content-Type': 'application/json'
-      }
-    };
-
     const response = await this.httpService.post<ApiResponse>(
       this.endpoint,
       queryParams,
-      body,
-      requestInit
+      body
     );
 
     const validationResult = this.apiResponseValidator.validate(response);