Merge fee65a6 into 1d659de

src/models/searchservice/response/Snippet.ts

@@ -4,7 +4,10 @@
  * @public
  */
 export interface Snippet {
-  /** The snippet's body of text */
+  /** The raw snippet value, or HTML if
+   *    - entity is of type HTML
+   *    - the conversion to HTML is enabled in search configuration
+   * */
   value: string,
   /** The locations in the document text of the {@link DirectAnswer.value} */
   matchedSubstrings: { offset: number, length: number }[]

src/models/searchservice/response/directanswer/BuiltInFieldType.ts

@@ -19,5 +19,8 @@ export enum BuiltInFieldType {
   Integer = 'integer',
   SingleLineText = 'single_line_text',
   RichText = 'rich_text',
-  MultiLineText = 'multi_line_text'
+  MultiLineText = 'multi_line_text',
+  RichText_v2 = 'rich_text_v2',
+  Html = 'html',
+  Markdown = 'markdown'
 }

src/models/searchservice/response/directanswer/DirectAnswer.ts

@@ -16,7 +16,7 @@ export interface DirectAnswer<T = unknown> {
    *
    * @remarks
    * A value will not be present if the {@link DirectAnswer."type"} is 'FEATURED_SNIPPET'
-   * and {@link DirectAnswer.fieldType} is 'rich_text'.
+   * and {@link DirectAnswer.fieldType} is 'rich_text', 'markdown', 'html' or 'rich_text_v2'.
    */
   value?: T,
   /** The entity associated with the direct answer. */

src/models/searchservice/response/directanswer/FeaturedSnippetDirectAnswer.ts

@@ -5,7 +5,10 @@ import { BuiltInFieldType } from './BuiltInFieldType';
 import { EnumOrLiteral } from '../../../utils/EnumOrLiteral';
 import {
   MultiLineTextSnippetDirectAnswer,
-  RichTextSnippetDirectAnswer
+  RichTextSnippetDirectAnswer,
+  RichTextV2SnippetDirectAnswer,
+  HTMLSnippetDirectAnswer,
+  MarkdownSnippetDirectAnswer
 } from './featuredsnippetdirectanswers';
 
 /**
@@ -17,7 +20,12 @@ export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnsw
   /** {@inheritDoc DirectAnswerType.FeaturedSnippet} */
   type: DirectAnswerType.FeaturedSnippet,
   /** {@inheritDoc DirectAnswer.fieldType} */
-  fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>,
+  fieldType: EnumOrLiteral<
+      BuiltInFieldType.MultiLineText |
+      BuiltInFieldType.RichText |
+      BuiltInFieldType.RichText_v2 |
+      BuiltInFieldType.Html |
+      BuiltInFieldType.Markdown>,
   /** The snippet where the direct answer was found. */
   snippet: Snippet
 }
@@ -28,4 +36,8 @@ export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnsw
  * @public
  */
 export type FeaturedSnippetDirectAnswer =
-  MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
+  MultiLineTextSnippetDirectAnswer |
+    RichTextSnippetDirectAnswer |
+    RichTextV2SnippetDirectAnswer |
+    HTMLSnippetDirectAnswer |
+    MarkdownSnippetDirectAnswer;

src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/HTMLSnippetDirectAnswer.ts

@@ -0,0 +1,14 @@
+import { EnumOrLiteral } from '../../../../utils/EnumOrLiteral';
+import { BuiltInFieldType } from '../BuiltInFieldType';
+import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer';
+
+/**
+ * A {@link BaseFeaturedSnippetDirectAnswer} with 'html' field type.
+ * "value" field is omitted for featured snippet direct answer of this field type.
+ *
+ * @public
+ */
+export interface HTMLSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    /** {@inheritDoc DirectAnswer.fieldType} */
+    fieldType: EnumOrLiteral<BuiltInFieldType.Html>
+}

src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/MarkdownSnippetDirectAnswer.ts

@@ -0,0 +1,14 @@
+import { EnumOrLiteral } from '../../../../utils/EnumOrLiteral';
+import { BuiltInFieldType } from '../BuiltInFieldType';
+import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer';
+
+/**
+ * A {@link BaseFeaturedSnippetDirectAnswer} with 'markdown' field type.
+ * "value" field is omitted for featured snippet direct answer of this field type.
+ *
+ * @public
+ */
+export interface MarkdownSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    /** {@inheritDoc DirectAnswer.fieldType} */
+    fieldType: EnumOrLiteral<BuiltInFieldType.Markdown>
+}

src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/RichTextV2SnippetDirectAnswer.ts

@@ -0,0 +1,14 @@
+import { EnumOrLiteral } from '../../../../utils/EnumOrLiteral';
+import { BuiltInFieldType } from '../BuiltInFieldType';
+import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer';
+
+/**
+ * A {@link BaseFeaturedSnippetDirectAnswer} with 'rich_text_v2' field type.
+ * "value" field is omitted for featured snippet direct answer of this field type.
+ *
+ * @public
+ */
+export interface RichTextV2SnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    /** {@inheritDoc DirectAnswer.fieldType} */
+    fieldType: EnumOrLiteral<BuiltInFieldType.RichText_v2>
+}

src/models/searchservice/response/directanswer/featuredsnippetdirectanswers/index.ts

@@ -1,2 +1,5 @@
 export { RichTextSnippetDirectAnswer } from './RichTextSnippetDirectAnswer';
 export { MultiLineTextSnippetDirectAnswer } from './MultiLineTextSnippetDirectAnswer';
+export { RichTextV2SnippetDirectAnswer } from './RichTextV2SnippetDirectAnswer';
+export {HTMLSnippetDirectAnswer} from './HTMLSnippetDirectAnswer';
+export {MarkdownSnippetDirectAnswer} from './MarkdownSnippetDirectAnswer';

src/transformers/searchservice/createDirectAnswer.ts

@@ -25,7 +25,11 @@ export function createDirectAnswer(data: any): FeaturedSnippetDirectAnswer | Fie
     };
   } else if (isFeaturedSnippetDirectAnswer) {
     const fieldType = commonDirectAnswerData.fieldType;
-    if (fieldType != BuiltInFieldType.MultiLineText && fieldType != BuiltInFieldType.RichText) {
+    if (fieldType != BuiltInFieldType.MultiLineText &&
+        fieldType != BuiltInFieldType.RichText &&
+        fieldType != BuiltInFieldType.RichText_v2 &&
+        fieldType != BuiltInFieldType.Html &&
+        fieldType != BuiltInFieldType.Markdown) {
       throw new Error(`Unexpected fieldType for featured snippet direct answer: ${fieldType}`);
     }
     return {