merge

.github/workflows/run-tests.yml

@@ -10,3 +10,15 @@ jobs:
     uses: yext/slapshot-reusable-workflows/.github/workflows/run_tests.yml@v1
     with:
       build_script: npm run build-ci
+
+  compilation_check_for_test_site:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+      - run: npm ci
+      - run: npm run build
+      - run: cd test-site
+      - run: npm i
+      - run: npm run build

docs/search-core.androidappurldirectanswer.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; [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md) &gt; [fieldType](./search-core.androidappurldirectanswer.fieldtype.md)
+
+## AndroidAppUrlDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.AndroidAppURL>;
+```

docs/search-core.androidappurldirectanswer.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; [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)
+
+## AndroidAppUrlDirectAnswer interface
+
+A direct answer for an android app url field.
+
+<b>Signature:</b>
+
+```typescript
+export interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;string&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.androidappurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.AndroidAppURL](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.builtinfieldtype.md

@@ -16,8 +16,17 @@ export declare enum BuiltInFieldType
 
 |  Member | Value | Description |
 |  --- | --- | --- |
+|  AndroidAppURL | <code>&quot;android_app_url&quot;</code> |  |
+|  ComplexURL | <code>&quot;complex_url&quot;</code> |  |
+|  Decimal | <code>&quot;decimal&quot;</code> |  |
+|  FacebookURL | <code>&quot;facebook_url&quot;</code> |  |
+|  InstagramHandle | <code>&quot;instagram_handle&quot;</code> |  |
+|  Integer | <code>&quot;integer&quot;</code> |  |
+|  IOSAppURL | <code>&quot;ios_app_url&quot;</code> |  |
 |  MultiLineText | <code>&quot;multi_line_text&quot;</code> |  |
 |  Phone | <code>&quot;phone&quot;</code> |  |
 |  RichText | <code>&quot;rich_text&quot;</code> |  |
 |  SingleLineText | <code>&quot;single_line_text&quot;</code> |  |
+|  TwitterHandle | <code>&quot;twitter_handle&quot;</code> |  |
+|  URL | <code>&quot;url&quot;</code> |  |
 

docs/search-core.complexurl.displayurl.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; [ComplexURL](./search-core.complexurl.md) &gt; [displayUrl](./search-core.complexurl.displayurl.md)
+
+## ComplexURL.displayUrl property
+
+<b>Signature:</b>
+
+```typescript
+displayUrl?: string;
+```

docs/search-core.complexurl.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [ComplexURL](./search-core.complexurl.md)
+
+## ComplexURL interface
+
+The shape of a [BuiltInFieldType.ComplexURL](./search-core.builtinfieldtype.md) DirectAnswer value
+
+<b>Signature:</b>
+
+```typescript
+export interface ComplexURL 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [displayUrl?](./search-core.complexurl.displayurl.md) | string | <i>(Optional)</i> |
+|  [preferDisplayUrl](./search-core.complexurl.preferdisplayurl.md) | boolean |  |
+|  [url](./search-core.complexurl.url.md) | string |  |
+

docs/search-core.complexurl.preferdisplayurl.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; [ComplexURL](./search-core.complexurl.md) &gt; [preferDisplayUrl](./search-core.complexurl.preferdisplayurl.md)
+
+## ComplexURL.preferDisplayUrl property
+
+<b>Signature:</b>
+
+```typescript
+preferDisplayUrl: boolean;
+```

docs/search-core.complexurl.url.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; [ComplexURL](./search-core.complexurl.md) &gt; [url](./search-core.complexurl.url.md)
+
+## ComplexURL.url property
+
+<b>Signature:</b>
+
+```typescript
+url: string;
+```

docs/search-core.complexurldirectanswer.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; [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md) &gt; [fieldType](./search-core.complexurldirectanswer.fieldtype.md)
+
+## ComplexUrlDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.ComplexURL>;
+```

docs/search-core.complexurldirectanswer.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; [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)
+
+## ComplexUrlDirectAnswer interface
+
+A direct answer for a complex url field.
+
+<b>Signature:</b>
+
+```typescript
+export interface ComplexUrlDirectAnswer extends BaseFieldValueDirectAnswer<ComplexURL> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;[ComplexURL](./search-core.complexurl.md)<!-- -->&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.complexurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.ComplexURL](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.decimaldirectanswer.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; [DecimalDirectAnswer](./search-core.decimaldirectanswer.md) &gt; [fieldType](./search-core.decimaldirectanswer.fieldtype.md)
+
+## DecimalDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.Decimal>;
+```

docs/search-core.decimaldirectanswer.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; [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)
+
+## DecimalDirectAnswer interface
+
+A direct answer for a decimal field, which is a number represented using a string.
+
+<b>Signature:</b>
+
+```typescript
+export interface DecimalDirectAnswer extends BaseFieldValueDirectAnswer<string | string[]> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;string \| string\[\]&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.decimaldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Decimal](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.facebookurldirectanswer.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; [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md) &gt; [fieldType](./search-core.facebookurldirectanswer.fieldtype.md)
+
+## FacebookUrlDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.FacebookURL>;
+```

docs/search-core.facebookurldirectanswer.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; [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)
+
+## FacebookUrlDirectAnswer interface
+
+A direct answer for a facebook url field.
+
+<b>Signature:</b>
+
+```typescript
+export interface FacebookUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;string&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.facebookurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.FacebookURL](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.featuredsnippetdirectanswer.md

@@ -9,7 +9,7 @@ All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeatur
 <b>Signature:</b>
 
 ```typescript
-export declare type FeaturedSnippetDirectAnswer = MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer;
+export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
 ```
-<b>References:</b> [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md)<!-- -->, [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md)
+<b>References:</b> [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)<!-- -->, [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)
 

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;
+export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer;
 ```
-<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.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)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)
 

docs/search-core.instagramhandledirectanswer.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; [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md) &gt; [fieldType](./search-core.instagramhandledirectanswer.fieldtype.md)
+
+## InstagramHandleDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.InstagramHandle>;
+```

docs/search-core.instagramhandledirectanswer.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; [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)
+
+## InstagramHandleDirectAnswer interface
+
+A direct answer for an instagram handle field.
+
+<b>Signature:</b>
+
+```typescript
+export interface InstagramHandleDirectAnswer extends BaseFieldValueDirectAnswer<string> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;string&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.instagramhandledirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.InstagramHandle](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.integerdirectanswer.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; [IntegerDirectAnswer](./search-core.integerdirectanswer.md) &gt; [fieldType](./search-core.integerdirectanswer.fieldtype.md)
+
+## IntegerDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.Integer>;
+```

docs/search-core.integerdirectanswer.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [IntegerDirectAnswer](./search-core.integerdirectanswer.md)
+
+## IntegerDirectAnswer interface
+
+A direct answer for an integer field.
+
+<b>Signature:</b>
+
+```typescript
+export interface IntegerDirectAnswer extends BaseFieldValueDirectAnswer<number> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;number&gt;
+
+## Remarks
+
+`IntegerDirectAnswer`<!-- -->s are only used for built in number fields. Custom number fields use [DecimalDirectAnswer](./search-core.decimaldirectanswer.md) instead.
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.integerdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Integer](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+

docs/search-core.iosappurldirectanswer.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; [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md) &gt; [fieldType](./search-core.iosappurldirectanswer.fieldtype.md)
+
+## IosAppUrlDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.IOSAppURL>;
+```

docs/search-core.iosappurldirectanswer.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; [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)
+
+## IosAppUrlDirectAnswer interface
+
+A direct answer for an iOS app url field.
+
+<b>Signature:</b>
+
+```typescript
+export interface IosAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> 
+```
+<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;string&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.iosappurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.IOSAppURL](./search-core.builtinfieldtype.md)<!-- -->&gt; |  |
+