throw error if featured snippet DA fieldtype is not multi line text O…

…R rich text
yext · Aug 15, 2022 · fcd9dc8 · fcd9dc8
1 parent 852e91d
commit fcd9dc8
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 4 deletions.
diff --git a/docs/search-core.directanswer.md b/docs/search-core.directanswer.md
@@ -19,6 +19,6 @@ export interface DirectAnswer<T = unknown>
 |  [fieldType](./search-core.directanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType](./search-core.builtinfieldtype.md)<!-- -->&gt; \| 'unknown' | The field type of the direct answer. |
 |  [relatedResult](./search-core.directanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
 |  [type](./search-core.directanswer.type.md) | [DirectAnswerType](./search-core.directanswertype.md) | The [DirectAnswerType](./search-core.directanswertype.md)<!-- -->. |
-|  [value?](./search-core.directanswer.value.md) | T | <i>(Optional)</i> The result of the direct answer. |
+|  [value?](./search-core.directanswer.value.md) | T | <i>(Optional)</i> The value of the direct answer. |
 |  [verticalKey](./search-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 
diff --git a/docs/search-core.directanswer.value.md b/docs/search-core.directanswer.value.md
@@ -4,7 +4,7 @@
 
 ## DirectAnswer.value property
 
-The result of the direct answer.
+The value of the direct answer.
 
 <b>Signature:</b>
 

diff --git a/src/models/searchservice/response/directanswer/DirectAnswer.ts b/src/models/searchservice/response/directanswer/DirectAnswer.ts
@@ -12,7 +12,7 @@ export interface DirectAnswer<T = unknown> {
   /** The {@link DirectAnswerType}. */
   type: DirectAnswerType,
   /**
-   * The result of the direct answer.
+   * The value of the direct answer.
    *
    * @remarks
    * A value will not be present if the {@link DirectAnswer."type"} is 'FEATURED_SNIPPET'

diff --git a/src/transformers/searchservice/createDirectAnswer.ts b/src/transformers/searchservice/createDirectAnswer.ts
@@ -24,12 +24,16 @@ export function createDirectAnswer(data: any): FeaturedSnippetDirectAnswer | Fie
       fieldApiName: data.answer.fieldApiName,
     };
   } else if (isFeaturedSnippetDirectAnswer) {
+    const fieldType = commonDirectAnswerData.fieldType;
+    if (fieldType != BuiltInFieldType.MultiLineText && fieldType != BuiltInFieldType.RichText) {
+      throw new Error(`Unexpected fieldType for featured snippet direct answer: ${fieldType}`);
+    }
     return {
       type: DirectAnswerType.FeaturedSnippet,
       ...commonDirectAnswerData,
       snippet: data.answer.snippet
     };
   } else {
-    throw new Error('The Search API returned an unknown direct answer type');
+    throw new Error(`The Search API returned an unknown direct answer type: ${data?.type}`);
   }
 }
diff --git a/tests/transformers/searchservice/createDirectAnswer.ts b/tests/transformers/searchservice/createDirectAnswer.ts
@@ -32,6 +32,26 @@ it('can create a FeaturedSnippetDirectAnswer', () => {
   expect(actualDirectAnswer).toMatchObject(expectedDirectAnswer);
 });
 
+it('can handle unexpected fieldType for a FeaturedSnippetDirectAnswer', () => {
+  const apiFeaturedSnippetDirectAnswer = {
+    type: 'FEATURED_SNIPPET',
+    answer: {
+      value: 'Honolulu. Hawaii',
+      fieldType: 'phone',
+      snippet: {
+        matchedSubstrings: [{ offset: 31, length: 16 }],
+        value: '111 222 3333'
+      }
+    },
+    relatedItem: {
+      verticalConfigId: 'wiki_bios',
+      data: {}
+    }
+  };
+  expect(() => createDirectAnswer(apiFeaturedSnippetDirectAnswer))
+    .toThrow('Unexpected fieldType for featured snippet direct answer: phone');
+});
+
 it('can create a FieldValueDirectAnswer', () => {
   const apiFieldValueDirectAnswer = {
     type: 'FIELD_VALUE',