added typeguard function for verticalResults

docs/search-headless.generativedirectanswerstate.isloading.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [GenerativeDirectAnswerState](./search-headless.generativedirectanswerstate.md) &gt; [isLoading](./search-headless.generativedirectanswerstate.isloading.md)
+
+## GenerativeDirectAnswerState.isLoading property
+
+Whether the AI generated answer is currently loading or has finished loading.
+
+<b>Signature:</b>
+
+```typescript
+isLoading?: boolean;
+```

docs/search-headless.generativedirectanswerstate.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [GenerativeDirectAnswerState](./search-headless.generativedirectanswerstate.md)
+
+## GenerativeDirectAnswerState interface
+
+Maintains the data for the latest generative direct answer.
+
+<b>Signature:</b>
+
+```typescript
+export interface GenerativeDirectAnswerState 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [isLoading?](./search-headless.generativedirectanswerstate.isloading.md) | boolean | <i>(Optional)</i> Whether the AI generated answer is currently loading or has finished loading. |
+|  [response?](./search-headless.generativedirectanswerstate.response.md) | [GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md) | <i>(Optional)</i> The generative direct answer response. |
+

docs/search-headless.generativedirectanswerstate.response.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [GenerativeDirectAnswerState](./search-headless.generativedirectanswerstate.md) &gt; [response](./search-headless.generativedirectanswerstate.response.md)
+
+## GenerativeDirectAnswerState.response property
+
+The generative direct answer response.
+
+<b>Signature:</b>
+
+```typescript
+response?: GenerativeDirectAnswerResponse;
+```

docs/search-headless.md

@@ -88,6 +88,7 @@
 |  [GenerativeDirectAnswerRequest](./search-headless.generativedirectanswerrequest.md) | Options which can be specified for a generative direct answer request. |
 |  [GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md) | A representation of a generative direct answer response. |
 |  [GenerativeDirectAnswerService](./search-headless.generativedirectanswerservice.md) | A service for generative direct answer requests. |
+|  [GenerativeDirectAnswerState](./search-headless.generativedirectanswerstate.md) | Maintains the data for the latest generative direct answer. |
 |  [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. |
 |  [HolidayHours](./search-headless.holidayhours.md) | An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |
 |  [Hours](./search-headless.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |

docs/search-headless.state.md

@@ -18,7 +18,7 @@ export interface State
 |  --- | --- | --- |
 |  [directAnswer](./search-headless.state.directanswer.md) | [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. |
 |  [filters](./search-headless.state.filters.md) | [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. |
-|  [generativeDirectAnswer](./search-headless.state.generativedirectanswer.md) | GenerativeDirectAnswerState | Maintains the data for the latest universal search. |
+|  [generativeDirectAnswer](./search-headless.state.generativedirectanswer.md) | [GenerativeDirectAnswerState](./search-headless.generativedirectanswerstate.md) | Maintains the data for the latest universal search. |
 |  [location](./search-headless.state.location.md) | [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. |
 |  [meta](./search-headless.state.meta.md) | [MetaState](./search-headless.metastate.md) | Maintains the metadata for Search Headless. |
 |  [query](./search-headless.state.query.md) | [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. |

etc/search-headless.api.md

@@ -442,6 +442,12 @@ export interface GenerativeDirectAnswerService {
     generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
 }
 
+// @public
+export interface GenerativeDirectAnswerState {
+    isLoading?: boolean;
+    response?: GenerativeDirectAnswerResponse;
+}
+
 // @public
 export type HeadlessConfig = SearchConfig & {
     headlessId?: string;
@@ -960,7 +966,6 @@ export enum SpellCheckType {
 export interface State {
     directAnswer: DirectAnswerState;
     filters: FiltersState;
-    // Warning: (ae-forgotten-export) The symbol "GenerativeDirectAnswerState" needs to be exported by the entry point index.d.ts
     generativeDirectAnswer: GenerativeDirectAnswerState;
     location: LocationState;
     meta: MetaState;

src/http-manager.ts

@@ -1,4 +1,4 @@
-type ServiceType = 'universalQuery' | 'verticalQuery';
+type ServiceType = 'universalQuery' | 'verticalQuery' | 'generativeDirectAnswer';
 
 type ServiceIds = {
   [key in ServiceType]: number;
@@ -18,12 +18,14 @@ export default class HttpManager {
   constructor() {
     this.latestRequestIds = {
       universalQuery: 0,
-      verticalQuery: 0
+      verticalQuery: 0,
+      generativeDirectAnswer: 0
     };
 
     this.latestResponseIds = {
       universalQuery: 0,
-      verticalQuery: 0
+      verticalQuery: 0,
+      generativeDirectAnswer: 0
     };
   }
 

src/models/index.ts

@@ -13,6 +13,7 @@ export { SessionTrackingState } from './slices/sessiontracking';
 export { SpellCheckState } from './slices/spellcheck';
 export { UniversalSearchState } from './slices/universal';
 export { VerticalSearchState, AllResultsForVertical } from './slices/vertical';
+export { GenerativeDirectAnswerState } from './slices/generativedirectanswer';
 
 // utils models
 export { BoundedRange, RangeBoundary } from './utils/boundedrange';

src/models/slices/vertical.ts

@@ -92,4 +92,13 @@ export interface VerticalSearchState {
    * The radius (in meters) to filter vertical searches by.
    */
   locationRadius?: number
-}
+}
+
+export function isVerticalResults(vertical: VerticalSearchState): vertical is VerticalResults {
+  return (vertical as VerticalResults).appliedQueryFilters !== undefined
+    && (vertical as VerticalResults).queryDurationMillis !== undefined
+    && (vertical as VerticalResults).results !== undefined
+    && (vertical as VerticalResults).resultsCount !== undefined
+    && (vertical as VerticalResults).source !== undefined
+    && (vertical as VerticalResults).verticalKey !== undefined;
+}

src/search-headless.ts

@@ -38,6 +38,7 @@ import { initialState as initialDirectAnswerState } from './slices/directanswer'
 import { initialState as initialQueryRulesState } from './slices/queryrules';
 import { initialState as initialSearchStatusState } from './slices/searchstatus';
 import { initialState as initialGenerativeDirectAnswerState } from './slices/generativedirectanswer';
+import { isVerticalResults } from './models/slices/vertical';
 
 /**
  * Provides the functionality for interacting with a Search experience.
@@ -566,29 +567,18 @@ export default class SearchHeadless {
    *          of undefined if there is no results defined in state
    */
   async executeGenerativeDirectAnswer(): Promise<GenerativeDirectAnswerResponse | undefined> {
+    const thisRequestId = this.httpManager.updateRequestId('generativeDirectAnswer');
     const searchId = this.state.meta.uuid;
     if (!searchId) {
       console.error('no search id supplied for generative direct answer');
       return;
     }
-    let requestName: 'universalQuery' | 'verticalQuery';
     let results: VerticalResults[] | undefined;
     if (this.state.meta.searchType === SearchTypeEnum.Vertical) {
-      requestName = 'verticalQuery';
-      if (this.state.vertical.appliedQueryFilters && this.state.vertical.queryDurationMillis 
-        && this.state.vertical.results && this.state.vertical.resultsCount 
-        && this.state.vertical.source && this.state.vertical.verticalKey ) {
-        results = [{
-          appliedQueryFilters: this.state.vertical.appliedQueryFilters,
-          queryDurationMillis: this.state.vertical.queryDurationMillis,
-          results: this.state.vertical.results,
-          resultsCount: this.state.vertical.resultsCount,
-          source: this.state.vertical.source,
-          verticalKey: this.state.vertical.verticalKey,
-        }];
+      if (isVerticalResults(this.state.vertical)) {
+        results = [this.state.vertical];
       }
     } else {
-      requestName = 'universalQuery';
       results = this.state.universal.verticals;
     }
     if (!results || results.length === 0) {
@@ -600,7 +590,6 @@ export default class SearchHeadless {
       console.error('no search term supplied for generative direct answer');
       return;
     }
-    const thisRequestId = this.httpManager.updateRequestId(requestName);
     this.stateManager.dispatchEvent('generativeDirectAnswer/setIsLoading', true);
 
     let response: GenerativeDirectAnswerResponse;
@@ -612,14 +601,14 @@ export default class SearchHeadless {
         additionalHttpHeaders: this.additionalHttpHeaders
       });
     } catch (e) {
-      const isLatestResponse = this.httpManager.processRequestId(requestName, thisRequestId);
+      const isLatestResponse = this.httpManager.processRequestId('generativeDirectAnswer', thisRequestId);
       if (isLatestResponse) {
         this.stateManager.dispatchEvent('generativeDirectAnswer/setIsLoading', false);
       }
       return Promise.reject(e);
     }
 
-    const isLatestResponse = this.httpManager.processRequestId(requestName, thisRequestId);
+    const isLatestResponse = this.httpManager.processRequestId('generativeDirectAnswer', thisRequestId);
     if (!isLatestResponse) {
       return response;
     }
@@ -628,4 +617,3 @@ export default class SearchHeadless {
     return response;
   }
 }
-