Merge 8cf3e61 into b69f8e5

docs/search-core.addressdirectanswer.fieldtype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [AddressDirectAnswer](./search-core.addressdirectanswer.md) &gt; [fieldType](./search-core.addressdirectanswer.fieldtype.md)
+
+## AddressDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.Address>;
+```

docs/search-core.addressdirectanswer.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [AddressDirectAnswer](./search-core.addressdirectanswer.md)
+
+## AddressDirectAnswer interface
+
+A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'address' field type.
+
+<b>Signature:</b>
+
+```typescript
+export interface AddressDirectAnswer extends BaseFieldValueDirectAnswer<Address> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;Address&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.addressdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Address](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.builtinfieldtype.md

@@ -16,6 +16,7 @@ export declare enum BuiltInFieldType
 
 |  Member | Value | Description |
 |  --- | --- | --- |
+|  Address | <code>&quot;address&quot;</code> |  |
 |  AndroidAppURL | <code>&quot;android_app_url&quot;</code> |  |
 |  ComplexURL | <code>&quot;complex_url&quot;</code> |  |
 |  Decimal | <code>&quot;decimal&quot;</code> |  |

docs/search-core.fieldvaluedirectanswer.md

@@ -9,7 +9,7 @@ Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefiel
 <b>Signature:</b>
 
 ```typescript
-export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer;
+export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | IntegerDirectAnswer | AddressDirectAnswer | ComplexUrlDirectAnswer;
 ```
-<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-core.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-core.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-core.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)
+<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-core.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-core.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-core.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)<!-- -->, [AddressDirectAnswer](./search-core.addressdirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)
 

docs/search-core.md

@@ -42,6 +42,7 @@
 |  Interface | Description |
 |  --- | --- |
 |  [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. |
+|  [AddressDirectAnswer](./search-core.addressdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'address' field type. |
 |  [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md) | A direct answer for an android app url field. |
 |  [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) |  |
 |  [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) |  |

etc/search-core.api.md

@@ -9,6 +9,14 @@ export interface AdditionalHttpHeaders {
     'Client-SDK'?: ClientSDKHeaderValues;
 }
 
+// Warning: (ae-forgotten-export) The symbol "Address" needs to be exported by the entry point index.d.ts
+//
+// @public
+export interface AddressDirectAnswer extends BaseFieldValueDirectAnswer<Address> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.Address>;
+}
+
 // @public
 export interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> {
     // (undocumented)
@@ -117,6 +125,8 @@ export interface BaseSearchConfig {
 
 // @public
 export enum BuiltInFieldType {
+    // (undocumented)
+    Address = "address",
     // (undocumented)
     AndroidAppURL = "android_app_url",
     // (undocumented)
@@ -285,7 +295,7 @@ export interface FailedVertical {
 export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
 
 // @public
-export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer;
+export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | IntegerDirectAnswer | AddressDirectAnswer | ComplexUrlDirectAnswer;
 
 // @public
 export interface FieldValueFilter {

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

@@ -13,7 +13,7 @@ export enum BuiltInFieldType {
   InstagramHandle = 'instagram_handle',
   TwitterHandle = 'twitter_handle',
   Phone = 'phone',
-  // Address = 'address',
+  Address = 'address',
   // Hours = 'hours',
   Decimal = 'decimal',
   Integer = 'integer',

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

@@ -9,8 +9,9 @@ import {
   RichTextDirectAnswer,
   UrlDirectAnswer,
   TextDirectAnswer,
-  ComplexUrlDirectAnswer,
-  IntegerDirectAnswer
+  IntegerDirectAnswer,
+  AddressDirectAnswer,
+  ComplexUrlDirectAnswer
 } from './fieldvaluedirectanswers';
 
 /**
@@ -29,5 +30,6 @@ export type FieldValueDirectAnswer =
   TwitterHandleDirectAnswer |
   IosAppUrlDirectAnswer |
   AndroidAppUrlDirectAnswer |
-  ComplexUrlDirectAnswer |
-  IntegerDirectAnswer;
+  IntegerDirectAnswer |
+  AddressDirectAnswer |
+  ComplexUrlDirectAnswer;

src/models/searchservice/response/directanswer/fieldvaluedirectanswers/AddressDirectAnswer.ts

@@ -0,0 +1,29 @@
+import { BuiltInFieldType } from '../BuiltInFieldType';
+import { BaseFieldValueDirectAnswer } from '../BaseFieldValueDirectAnswer';
+import { EnumOrLiteral } from '../../../../utils/EnumOrLiteral';
+
+/**
+ * A {@link BaseFieldValueDirectAnswer} interface with 'address' field type.
+ *
+ * @public
+ */
+export interface AddressDirectAnswer extends BaseFieldValueDirectAnswer<Address> {
+  fieldType: EnumOrLiteral<BuiltInFieldType.Address>
+}
+
+/**
+ * An interface with address fields to use in {@link BaseFieldValueDirectAnswer.value}.
+ *
+ * @public
+ */
+export interface Address {
+  line1: string,
+  line2?: string,
+  line3?: string,
+  sublocality?: string,
+  city: string,
+  region: string,
+  postalCode: string,
+  extraDescription?: string,
+  countryCode?: string
+}

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

@@ -10,3 +10,4 @@ export { UrlDirectAnswer } from './UrlDirectAnswer';
 export { TextDirectAnswer } from './TextDirectAnswer';
 export { ComplexUrlDirectAnswer, ComplexURL } from './ComplexUrlDirectAnswer';
 export { IntegerDirectAnswer } from './IntegerDirectAnswer';
+export { AddressDirectAnswer } from './AddressDirectAnswer';

test-site/src/ts/initDirectAnswers.ts

@@ -49,6 +49,9 @@ const FIELD_VALUE_QUERIES = {
   ],
   [BuiltInFieldType.Integer]: [
     'oliver shi outdoor pools?' // number
+  ],
+  [BuiltInFieldType.Address]: [
+    'oliver shi outdoor address?' // Address
   ]
 };
 
@@ -124,6 +127,9 @@ function ensureFieldValueSwitchability(da: FieldValueDirectAnswer) {
     case BuiltInFieldType.Integer:
       console.log(da.value);
       break;
+    case BuiltInFieldType.Address:
+      console.log(da.value);
+      break;
   }
 }