make queryDurationMillis field optional in VerticalResults (#266)

J=CLIP-1318
TEST=auto,manual

ran `npm run test`. Tested this change together with the rest of the sdk to confirm that gda is executed successfully after executeVerticalQuery finishes.

docs/search-core.verticalresults.md

@@ -14,7 +14,18 @@ export interface VerticalResults
 
 ## Properties
 
+<<<<<<< HEAD
 <table><thead><tr><th>
+=======
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [appliedQueryFilters](./search-core.verticalresults.appliedqueryfilters.md) | [AppliedQueryFilter](./search-core.appliedqueryfilter.md)<!-- -->\[\] | A array of [AppliedQueryFilter](./search-core.appliedqueryfilter.md)<!-- -->s which were applied to the vertical results. |
+|  [queryDurationMillis?](./search-core.verticalresults.querydurationmillis.md) | number | <i>(Optional)</i> The duration of the query in milliseconds |
+|  [results](./search-core.verticalresults.results.md) | [Result](./search-core.result.md)<!-- -->\[\] | An array of search [Result](./search-core.result.md)<!-- -->s for the vertical. |
+|  [resultsCount](./search-core.verticalresults.resultscount.md) | number | The total number of results within the vertical. |
+|  [source](./search-core.verticalresults.source.md) | [Source](./search-core.source.md) | Represents the source of a [Result](./search-core.result.md)<!-- -->. |
+|  [verticalKey](./search-core.verticalresults.verticalkey.md) | string | The vertical key associated with the vertical results. |
+>>>>>>> 8035fcc (make `queryDurationMillis` field optional in VerticalResults (#266))
 
 Property
 

docs/search-core.verticalresults.querydurationmillis.md

@@ -4,10 +4,15 @@
 
 ## VerticalResults.queryDurationMillis property
 
-The duration of the query in milliseconds.
+The duration of the query in milliseconds
 
 **Signature:**
 
 ```typescript
-queryDurationMillis: number;
+queryDurationMillis?: number;
 ```
+
+## Remarks
+
+This is present in a universal search but not in a vertical search.
+

etc/search-core.api.md

@@ -865,7 +865,7 @@ export interface VerticalAutocompleteRequest extends SearchRequest {
 // @public
 export interface VerticalResults {
     appliedQueryFilters: AppliedQueryFilter[];
-    queryDurationMillis: number;
+    queryDurationMillis?: number;
     results: Result[];
     resultsCount: number;
     source: Source;

package.json

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

src/models/searchservice/response/VerticalResults.ts

@@ -10,8 +10,12 @@ import { Source } from './Source';
 export interface VerticalResults {
   /** A array of {@link AppliedQueryFilter}s which were applied to the vertical results. */
   appliedQueryFilters: AppliedQueryFilter[],
-  /** The duration of the query in milliseconds. */
-  queryDurationMillis: number,
+  /** The duration of the query in milliseconds
+   *
+   * @remarks
+   * This is present in a universal search but not in a vertical search.
+  */
+  queryDurationMillis?: number,
   /** An array of search {@link Result}s for the vertical. */
   results: Result[],
   /**

tests/infra/GenerativeDirectAnswerServiceImpl.ts

@@ -14,7 +14,6 @@ const defaultEndpoints: Required<Endpoints> = new EndpointsFactory().getEndpoint
 
 const mockVerticalResults = [{
   'appliedQueryFilters': [],
-  'queryDurationMillis': 141,
   'results': [
     {
       'distance': 608,
@@ -142,28 +141,31 @@ it('additionalQueryParams are passed through', async () => {
   }));
 });
 
-const mockUniversalResults = [mockVerticalResults, {
-  'appliedQueryFilters': [],
-  'queryDurationMillis': 313,
-  'results': [
-    {
-      'id': '4038721755206544552',
-      'index': 3,
-      'name': 'How do I create a Very Special Event?',
-      'rawData': {
+const mockUniversalResults = [
+  { ...mockVerticalResults, 'queryDurationMillis': 141 },
+  {
+    'appliedQueryFilters': [],
+    'queryDurationMillis': 313,
+    'results': [
+      {
         'id': '4038721755206544552',
+        'index': 3,
         'name': 'How do I create a Very Special Event?',
-        'question': 'How do I create a Very Special Event?',
-        'type': 'faq',
-        'uid': '8367352'
-      },
-      'source': 'CUSTOM_SEARCHER'
-    }
-  ],
-  'resultsCount': 1,
-  'source': 'DOCUMENT_VERTICAL',
-  'verticalKey': 'faq_vector'
-}];
+        'rawData': {
+          'id': '4038721755206544552',
+          'name': 'How do I create a Very Special Event?',
+          'question': 'How do I create a Very Special Event?',
+          'type': 'faq',
+          'uid': '8367352'
+        },
+        'source': 'CUSTOM_SEARCHER'
+      }
+    ],
+    'resultsCount': 1,
+    'source': 'DOCUMENT_VERTICAL',
+    'verticalKey': 'faq_vector'
+  }
+];
 
 const gdaRequestUniversalResults: GenerativeDirectAnswerRequest = {
   searchId: 'testSeachId',