-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
re-export DA interfaces from search-core (#131)
- update search-core version to be 2.0.0-alpha.215 which the new DA interfaces. re-export those DA interfaces in headless. - fix some new TS issues in DA jest test and existing issues in facets and verticalSearch test. bump headless version to 2.0.0-alpha.131, to be publish after this pr is merged J=SLAP-2324 TEST=none
- Loading branch information
Showing
72 changed files
with
962 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AddressDirectAnswer](./search-headless.addressdirectanswer.md) > [fieldType](./search-headless.addressdirectanswer.fieldtype.md) | ||
|
||
## AddressDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.Address>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AddressDirectAnswer](./search-headless.addressdirectanswer.md) | ||
|
||
## AddressDirectAnswer interface | ||
|
||
A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'address' field type. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface AddressDirectAnswer extends BaseFieldValueDirectAnswer<Address> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><Address> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.addressdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.Address](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
11 changes: 11 additions & 0 deletions
11
docs/search-headless.androidappurldirectanswer.fieldtype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) > [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) | ||
|
||
## AndroidAppUrlDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.AndroidAppURL>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) | ||
|
||
## AndroidAppUrlDirectAnswer interface | ||
|
||
A direct answer for an android app url field. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><string> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.AndroidAppURL](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
13 changes: 13 additions & 0 deletions
13
docs/search-headless.basefeaturedsnippetdirectanswer.fieldtype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) > [fieldType](./search-headless.basefeaturedsnippetdirectanswer.fieldtype.md) | ||
|
||
## BaseFeaturedSnippetDirectAnswer.fieldType property | ||
|
||
The field type of the direct answer. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) | ||
|
||
## BaseFeaturedSnippetDirectAnswer interface | ||
|
||
A direct answer which was found within a document. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> | ||
``` | ||
<b>Extends:</b> [DirectAnswer](./search-headless.directanswer.md)<!-- --><T> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.basefeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.MultiLineText](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-headless.builtinfieldtype.md)<!-- -->> | The field type of the direct answer. | | ||
| [snippet](./search-headless.basefeaturedsnippetdirectanswer.snippet.md) | [Snippet](./search-headless.snippet.md) | The snippet where the direct answer was found. | | ||
| [type](./search-headless.basefeaturedsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-headless.directanswertype.md) | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md)<!-- -->. | | ||
4 changes: 2 additions & 2 deletions
4
...ss.featuredsnippetdirectanswer.snippet.md → ...asefeaturedsnippetdirectanswer.snippet.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/search-headless.basefeaturedsnippetdirectanswer.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) > [type](./search-headless.basefeaturedsnippetdirectanswer.type.md) | ||
|
||
## BaseFeaturedSnippetDirectAnswer.type property | ||
|
||
Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: DirectAnswerType.FeaturedSnippet; | ||
``` |
4 changes: 2 additions & 2 deletions
4
...less.fieldvaluedirectanswer.entityname.md → ....basefieldvaluedirectanswer.entityname.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ss.fieldvaluedirectanswer.fieldapiname.md → ...asefieldvaluedirectanswer.fieldapiname.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...dless.fieldvaluedirectanswer.fieldname.md → ...s.basefieldvaluedirectanswer.fieldname.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) | ||
|
||
## BaseFieldValueDirectAnswer interface | ||
|
||
A direct answer where the answer came from a field from the knowledge graph. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface BaseFieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> | ||
``` | ||
<b>Extends:</b> [DirectAnswer](./search-headless.directanswer.md)<!-- --><T> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [entityName](./search-headless.basefieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | | ||
| [fieldApiName](./search-headless.basefieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | | ||
| [fieldName](./search-headless.basefieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | | ||
| [type](./search-headless.basefieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-headless.directanswertype.md) | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md)<!-- -->. | | ||
| [value](./search-headless.basefieldvaluedirectanswer.value.md) | T | The result of the direct answer. | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) > [type](./search-headless.basefieldvaluedirectanswer.type.md) | ||
|
||
## BaseFieldValueDirectAnswer.type property | ||
|
||
Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: DirectAnswerType.FieldValue; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) > [value](./search-headless.basefieldvaluedirectanswer.value.md) | ||
|
||
## BaseFieldValueDirectAnswer.value property | ||
|
||
The result of the direct answer. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
value: T; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BuiltInFieldType](./search-headless.builtinfieldtype.md) | ||
|
||
## BuiltInFieldType enum | ||
|
||
Possible built-in field types for [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare enum BuiltInFieldType | ||
``` | ||
|
||
## Enumeration Members | ||
|
||
| Member | Value | Description | | ||
| --- | --- | --- | | ||
| Address | <code>"address"</code> | | | ||
| AndroidAppURL | <code>"android_app_url"</code> | | | ||
| ComplexURL | <code>"complex_url"</code> | | | ||
| Decimal | <code>"decimal"</code> | | | ||
| Email | <code>"email"</code> | | | ||
| FacebookURL | <code>"facebook_url"</code> | | | ||
| InstagramHandle | <code>"instagram_handle"</code> | | | ||
| Integer | <code>"integer"</code> | | | ||
| IOSAppURL | <code>"ios_app_url"</code> | | | ||
| MultiLineText | <code>"multi_line_text"</code> | | | ||
| Phone | <code>"phone"</code> | | | ||
| RichText | <code>"rich_text"</code> | | | ||
| SingleLineText | <code>"single_line_text"</code> | | | ||
| TwitterHandle | <code>"twitter_handle"</code> | | | ||
| URL | <code>"url"</code> | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) > [fieldType](./search-headless.complexurldirectanswer.fieldtype.md) | ||
|
||
## ComplexUrlDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.ComplexURL>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) | ||
|
||
## ComplexUrlDirectAnswer interface | ||
|
||
A direct answer for a complex url field. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface ComplexUrlDirectAnswer extends BaseFieldValueDirectAnswer<ComplexURL> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><ComplexURL> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.complexurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.ComplexURL](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) > [fieldType](./search-headless.decimaldirectanswer.fieldtype.md) | ||
|
||
## DecimalDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.Decimal>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) | ||
|
||
## DecimalDirectAnswer interface | ||
|
||
A direct answer for a decimal field, which is a number represented using a string. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface DecimalDirectAnswer extends BaseFieldValueDirectAnswer<string | string[]> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><string \| string\[\]> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.decimaldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.Decimal](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [EmailDirectAnswer](./search-headless.emaildirectanswer.md) > [fieldType](./search-headless.emaildirectanswer.fieldtype.md) | ||
|
||
## EmailDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.Email>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [EmailDirectAnswer](./search-headless.emaildirectanswer.md) | ||
|
||
## EmailDirectAnswer interface | ||
|
||
A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'email' field type. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface EmailDirectAnswer extends BaseFieldValueDirectAnswer<string[]> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><string\[\]> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.emaildirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.Email](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
Oops, something went wrong.