Merge a9b9277 into facc939

src/models/index.ts

@@ -70,6 +70,7 @@ export { VerticalSearchResponse } from './searchservice/response/VerticalSearchR
 export { Snippet } from './searchservice/response/Snippet';
 export { ErrorType } from './searchservice/response/ErrorType';
 export { FailedVertical } from './searchservice/response/FailedVertical';
+export { FieldType } from './searchservice/response/FieldType';
 
 // Search service common models
 export { Matcher } from './searchservice/common/Matcher';
@@ -78,3 +79,6 @@ export {
   LowerNumberRangeLimit,
   UpperNumberRangeLimit
 } from './searchservice/common/NumberRangeValue';
+
+// Utils
+export { EnumOrLiteral } from './utils/EnumOrLiteral';

src/models/searchservice/response/DirectAnswer.ts

@@ -1,12 +1,14 @@
 import { Result } from './Result';
 import { DirectAnswerType } from './DirectAnswerType';
+import { FieldType } from './FieldType';
+import { EnumOrLiteral } from '../../utils/EnumOrLiteral';
 
 /**
  * A direct answer to a search.
  *
  * @public
  */
-export interface DirectAnswer {
+export interface DirectAnswer<T = unknown> {
   /** The {@link DirectAnswerType}. */
   type: DirectAnswerType,
   /**
@@ -15,11 +17,11 @@ export interface DirectAnswer {
    * @remarks
    * A value will not be present if the {@link DirectAnswer.fieldType} is 'rich_text'.
    */
-  value?: string,
+  value?: T,
   /** The entity associated with the direct answer. */
   relatedResult: Result,
   /** The vertical key of the direct answer. */
   verticalKey: string,
   /** The field type of the direct answer. */
-  fieldType: string
+  fieldType: EnumOrLiteral<FieldType>
 }

src/models/searchservice/response/FeaturedSnippetDirectAnswer.ts

@@ -1,5 +1,7 @@
+import { EnumOrLiteral } from '../../utils/EnumOrLiteral';
 import { DirectAnswer } from './DirectAnswer';
 import { DirectAnswerType } from './DirectAnswerType';
+import { FieldType } from './FieldType';
 import { Result } from './Result';
 import { Snippet } from './Snippet';
 
@@ -18,7 +20,7 @@ export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
   /** {@inheritDoc DirectAnswer.verticalKey} */
   verticalKey: string,
   /** {@inheritDoc DirectAnswer.fieldType} */
-  fieldType: string,
+  fieldType: EnumOrLiteral<FieldType>,
   /** The snippet where the direct answer was found. */
   snippet: Snippet
 }

src/models/searchservice/response/FieldType.ts

@@ -0,0 +1,21 @@
+/**
+ * Possible field types for {@link DirectAnswer.fieldType}.
+ * @public
+ */
+export enum FieldType {
+  // URL = 'url',
+  // ComplexURL = 'complex_url',
+  // IOSAppURL = 'ios_app_url',
+  // AndroidAppURL = 'android_app_url',
+  // FacebookURL = 'facebook_url',
+  // Email = 'email',
+  // InstagramHandle = 'instagram_handle',
+  // TwitterHandle = 'twitter_handle',
+  // Phone = 'phone',
+  Address = 'address',
+  // Hours = 'hours',
+  // Decimal = 'decimal',
+  // RichText = 'rich_text',
+  // SingleLineText = 'single_line_text',
+  // MultiLineText = 'multi_line_text'
+}

src/models/searchservice/response/FieldValueDirectAnswer.ts

@@ -1,23 +1,25 @@
+import { EnumOrLiteral } from '../../utils/EnumOrLiteral';
 import { DirectAnswer } from './DirectAnswer';
 import { DirectAnswerType } from './DirectAnswerType';
+import { FieldType } from './FieldType';
 import { Result } from './Result';
 
 /**
  * A direct answer where the answer came from a field from the knowledge graph.
  *
  * @public
  */
-export interface FieldValueDirectAnswer extends DirectAnswer {
+export interface FieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> {
   /** {@link DirectAnswerType}.FieldValue. */
   type: DirectAnswerType.FieldValue,
   /** {@inheritDoc DirectAnswer.value} */
-  value: string,
+  value: T,
   /** {@inheritDoc DirectAnswer.relatedResult} */
   relatedResult: Result,
   /** {@inheritDoc DirectAnswer.verticalKey} */
   verticalKey: string,
   /** {@inheritDoc DirectAnswer.fieldType} */
-  fieldType: string,
+  fieldType: EnumOrLiteral<FieldType>,
   /** The name of the entity that direct answer came from. */
   entityName: string,
   /** The field name of the direct answer. */

src/models/utils/EnumOrLiteral.ts

@@ -0,0 +1,6 @@
+/**
+ * Produces a union type from the enum passed as a generic which consists of the enum values
+ * and the string literals of the enum.
+ * @public
+ */
+export type EnumOrLiteral<T extends string> = T | `${T}`;