diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES index e27abe8a..248002cd 100644 --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -62,7 +62,7 @@ SOFTWARE. The following NPM package may be included in this product: - - @yext/search-core@2.0.0-alpha.204 + - @yext/search-core@2.0.0-alpha.215 This package contains the following license and notice below: diff --git a/docs/search-headless.addressdirectanswer.fieldtype.md b/docs/search-headless.addressdirectanswer.fieldtype.md new file mode 100644 index 00000000..c17b4b81 --- /dev/null +++ b/docs/search-headless.addressdirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AddressDirectAnswer](./search-headless.addressdirectanswer.md) > [fieldType](./search-headless.addressdirectanswer.fieldtype.md) + +## AddressDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.addressdirectanswer.md b/docs/search-headless.addressdirectanswer.md new file mode 100644 index 00000000..095e25fc --- /dev/null +++ b/docs/search-headless.addressdirectanswer.md @@ -0,0 +1,21 @@ + + +[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. + +Signature: + +```typescript +export declare interface AddressDirectAnswer extends BaseFieldValueDirectAnswer
+``` +Extends: [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)> | | + diff --git a/docs/search-headless.androidappurldirectanswer.fieldtype.md b/docs/search-headless.androidappurldirectanswer.fieldtype.md new file mode 100644 index 00000000..128d5ed8 --- /dev/null +++ b/docs/search-headless.androidappurldirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) > [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) + +## AndroidAppUrlDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.androidappurldirectanswer.md b/docs/search-headless.androidappurldirectanswer.md new file mode 100644 index 00000000..2ccaa563 --- /dev/null +++ b/docs/search-headless.androidappurldirectanswer.md @@ -0,0 +1,21 @@ + + +[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. + +Signature: + +```typescript +export declare interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [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)> | | + diff --git a/docs/search-headless.basefeaturedsnippetdirectanswer.fieldtype.md b/docs/search-headless.basefeaturedsnippetdirectanswer.fieldtype.md new file mode 100644 index 00000000..ad63ec38 --- /dev/null +++ b/docs/search-headless.basefeaturedsnippetdirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[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. + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.basefeaturedsnippetdirectanswer.md b/docs/search-headless.basefeaturedsnippetdirectanswer.md new file mode 100644 index 00000000..83a497b0 --- /dev/null +++ b/docs/search-headless.basefeaturedsnippetdirectanswer.md @@ -0,0 +1,23 @@ + + +[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. + +Signature: + +```typescript +export declare interface BaseFeaturedSnippetDirectAnswer extends DirectAnswer +``` +Extends: [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). | + diff --git a/docs/search-headless.featuredsnippetdirectanswer.snippet.md b/docs/search-headless.basefeaturedsnippetdirectanswer.snippet.md similarity index 51% rename from docs/search-headless.featuredsnippetdirectanswer.snippet.md rename to docs/search-headless.basefeaturedsnippetdirectanswer.snippet.md index 747c6ab6..eb9c049f 100644 --- a/docs/search-headless.featuredsnippetdirectanswer.snippet.md +++ b/docs/search-headless.basefeaturedsnippetdirectanswer.snippet.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [snippet](./search-headless.featuredsnippetdirectanswer.snippet.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) > [snippet](./search-headless.basefeaturedsnippetdirectanswer.snippet.md) -## FeaturedSnippetDirectAnswer.snippet property +## BaseFeaturedSnippetDirectAnswer.snippet property The snippet where the direct answer was found. diff --git a/docs/search-headless.basefeaturedsnippetdirectanswer.type.md b/docs/search-headless.basefeaturedsnippetdirectanswer.type.md new file mode 100644 index 00000000..97306ab7 --- /dev/null +++ b/docs/search-headless.basefeaturedsnippetdirectanswer.type.md @@ -0,0 +1,13 @@ + + +[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). + +Signature: + +```typescript +type: DirectAnswerType.FeaturedSnippet; +``` diff --git a/docs/search-headless.fieldvaluedirectanswer.entityname.md b/docs/search-headless.basefieldvaluedirectanswer.entityname.md similarity index 52% rename from docs/search-headless.fieldvaluedirectanswer.entityname.md rename to docs/search-headless.basefieldvaluedirectanswer.entityname.md index bdafa039..f7a0067a 100644 --- a/docs/search-headless.fieldvaluedirectanswer.entityname.md +++ b/docs/search-headless.basefieldvaluedirectanswer.entityname.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [entityName](./search-headless.fieldvaluedirectanswer.entityname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) > [entityName](./search-headless.basefieldvaluedirectanswer.entityname.md) -## FieldValueDirectAnswer.entityName property +## BaseFieldValueDirectAnswer.entityName property The name of the entity that direct answer came from. diff --git a/docs/search-headless.fieldvaluedirectanswer.fieldapiname.md b/docs/search-headless.basefieldvaluedirectanswer.fieldapiname.md similarity index 51% rename from docs/search-headless.fieldvaluedirectanswer.fieldapiname.md rename to docs/search-headless.basefieldvaluedirectanswer.fieldapiname.md index 1455cd0a..36d31064 100644 --- a/docs/search-headless.fieldvaluedirectanswer.fieldapiname.md +++ b/docs/search-headless.basefieldvaluedirectanswer.fieldapiname.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [fieldApiName](./search-headless.fieldvaluedirectanswer.fieldapiname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) > [fieldApiName](./search-headless.basefieldvaluedirectanswer.fieldapiname.md) -## FieldValueDirectAnswer.fieldApiName property +## BaseFieldValueDirectAnswer.fieldApiName property The field api name of the direct answer. diff --git a/docs/search-headless.fieldvaluedirectanswer.fieldname.md b/docs/search-headless.basefieldvaluedirectanswer.fieldname.md similarity index 51% rename from docs/search-headless.fieldvaluedirectanswer.fieldname.md rename to docs/search-headless.basefieldvaluedirectanswer.fieldname.md index eb88a940..974c8304 100644 --- a/docs/search-headless.fieldvaluedirectanswer.fieldname.md +++ b/docs/search-headless.basefieldvaluedirectanswer.fieldname.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [fieldName](./search-headless.fieldvaluedirectanswer.fieldname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) > [fieldName](./search-headless.basefieldvaluedirectanswer.fieldname.md) -## FieldValueDirectAnswer.fieldName property +## BaseFieldValueDirectAnswer.fieldName property The field name of the direct answer. diff --git a/docs/search-headless.basefieldvaluedirectanswer.md b/docs/search-headless.basefieldvaluedirectanswer.md new file mode 100644 index 00000000..1674b40f --- /dev/null +++ b/docs/search-headless.basefieldvaluedirectanswer.md @@ -0,0 +1,25 @@ + + +[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. + +Signature: + +```typescript +export declare interface BaseFieldValueDirectAnswer extends DirectAnswer +``` +Extends: [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. | + diff --git a/docs/search-headless.basefieldvaluedirectanswer.type.md b/docs/search-headless.basefieldvaluedirectanswer.type.md new file mode 100644 index 00000000..0c7b80d3 --- /dev/null +++ b/docs/search-headless.basefieldvaluedirectanswer.type.md @@ -0,0 +1,13 @@ + + +[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). + +Signature: + +```typescript +type: DirectAnswerType.FieldValue; +``` diff --git a/docs/search-headless.basefieldvaluedirectanswer.value.md b/docs/search-headless.basefieldvaluedirectanswer.value.md new file mode 100644 index 00000000..2f9b7bb6 --- /dev/null +++ b/docs/search-headless.basefieldvaluedirectanswer.value.md @@ -0,0 +1,13 @@ + + +[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. + +Signature: + +```typescript +value: T; +``` diff --git a/docs/search-headless.builtinfieldtype.md b/docs/search-headless.builtinfieldtype.md new file mode 100644 index 00000000..6aaed651 --- /dev/null +++ b/docs/search-headless.builtinfieldtype.md @@ -0,0 +1,34 @@ + + +[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). + +Signature: + +```typescript +export declare enum BuiltInFieldType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Address | "address" | | +| AndroidAppURL | "android_app_url" | | +| ComplexURL | "complex_url" | | +| Decimal | "decimal" | | +| Email | "email" | | +| FacebookURL | "facebook_url" | | +| InstagramHandle | "instagram_handle" | | +| Integer | "integer" | | +| IOSAppURL | "ios_app_url" | | +| MultiLineText | "multi_line_text" | | +| Phone | "phone" | | +| RichText | "rich_text" | | +| SingleLineText | "single_line_text" | | +| TwitterHandle | "twitter_handle" | | +| URL | "url" | | + diff --git a/docs/search-headless.complexurldirectanswer.fieldtype.md b/docs/search-headless.complexurldirectanswer.fieldtype.md new file mode 100644 index 00000000..c195aa87 --- /dev/null +++ b/docs/search-headless.complexurldirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) > [fieldType](./search-headless.complexurldirectanswer.fieldtype.md) + +## ComplexUrlDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.complexurldirectanswer.md b/docs/search-headless.complexurldirectanswer.md new file mode 100644 index 00000000..7131e223 --- /dev/null +++ b/docs/search-headless.complexurldirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) + +## ComplexUrlDirectAnswer interface + +A direct answer for a complex url field. + +Signature: + +```typescript +export declare interface ComplexUrlDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [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)> | | + diff --git a/docs/search-headless.decimaldirectanswer.fieldtype.md b/docs/search-headless.decimaldirectanswer.fieldtype.md new file mode 100644 index 00000000..2b6b770e --- /dev/null +++ b/docs/search-headless.decimaldirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) > [fieldType](./search-headless.decimaldirectanswer.fieldtype.md) + +## DecimalDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.decimaldirectanswer.md b/docs/search-headless.decimaldirectanswer.md new file mode 100644 index 00000000..a1a6dd6c --- /dev/null +++ b/docs/search-headless.decimaldirectanswer.md @@ -0,0 +1,21 @@ + + +[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. + +Signature: + +```typescript +export declare interface DecimalDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [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)> | | + diff --git a/docs/search-headless.directanswer.fieldtype.md b/docs/search-headless.directanswer.fieldtype.md index ea65955b..7fccb852 100644 --- a/docs/search-headless.directanswer.fieldtype.md +++ b/docs/search-headless.directanswer.fieldtype.md @@ -9,5 +9,5 @@ The field type of the direct answer. Signature: ```typescript -fieldType: BuiltInFieldType | string; +fieldType: EnumOrLiteral | 'unknown'; ``` diff --git a/docs/search-headless.directanswer.md b/docs/search-headless.directanswer.md index 6a500dec..cbb23006 100644 --- a/docs/search-headless.directanswer.md +++ b/docs/search-headless.directanswer.md @@ -16,9 +16,9 @@ export declare interface DirectAnswer | Property | Type | Description | | --- | --- | --- | -| [fieldType](./search-headless.directanswer.fieldtype.md) | BuiltInFieldType \| string | The field type of the direct answer. | +| [fieldType](./search-headless.directanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType](./search-headless.builtinfieldtype.md)> \| 'unknown' | The field type of the direct answer. | | [relatedResult](./search-headless.directanswer.relatedresult.md) | [Result](./search-headless.result.md) | The entity associated with the direct answer. | | [type](./search-headless.directanswer.type.md) | [DirectAnswerType](./search-headless.directanswertype.md) | The [DirectAnswerType](./search-headless.directanswertype.md). | -| [value?](./search-headless.directanswer.value.md) | T | (Optional) The result of the direct answer. | +| [value?](./search-headless.directanswer.value.md) | T | (Optional) The value of the direct answer. | | [verticalKey](./search-headless.directanswer.verticalkey.md) | string | The vertical key of the direct answer. | diff --git a/docs/search-headless.directanswer.value.md b/docs/search-headless.directanswer.value.md index 9a96c79b..cf387cf4 100644 --- a/docs/search-headless.directanswer.value.md +++ b/docs/search-headless.directanswer.value.md @@ -4,7 +4,7 @@ ## DirectAnswer.value property -The result of the direct answer. +The value of the direct answer. Signature: @@ -14,5 +14,5 @@ value?: T; ## Remarks -A value will not be present if the [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. +A value will not be present if the [DirectAnswer.type](./search-headless.directanswer.type.md) is 'FEATURED\_SNIPPET' and [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. diff --git a/docs/search-headless.emaildirectanswer.fieldtype.md b/docs/search-headless.emaildirectanswer.fieldtype.md new file mode 100644 index 00000000..29c9f52f --- /dev/null +++ b/docs/search-headless.emaildirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [EmailDirectAnswer](./search-headless.emaildirectanswer.md) > [fieldType](./search-headless.emaildirectanswer.fieldtype.md) + +## EmailDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.emaildirectanswer.md b/docs/search-headless.emaildirectanswer.md new file mode 100644 index 00000000..fb0acf19 --- /dev/null +++ b/docs/search-headless.emaildirectanswer.md @@ -0,0 +1,21 @@ + + +[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. + +Signature: + +```typescript +export declare interface EmailDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [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)> | | + diff --git a/docs/search-headless.facebookurldirectanswer.fieldtype.md b/docs/search-headless.facebookurldirectanswer.fieldtype.md new file mode 100644 index 00000000..9cc137ff --- /dev/null +++ b/docs/search-headless.facebookurldirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md) > [fieldType](./search-headless.facebookurldirectanswer.fieldtype.md) + +## FacebookUrlDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.facebookurldirectanswer.md b/docs/search-headless.facebookurldirectanswer.md new file mode 100644 index 00000000..9253a8d1 --- /dev/null +++ b/docs/search-headless.facebookurldirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md) + +## FacebookUrlDirectAnswer interface + +A direct answer for a facebook url field. + +Signature: + +```typescript +export declare interface FacebookUrlDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.facebookurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.FacebookURL](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.featuredsnippetdirectanswer.fieldtype.md b/docs/search-headless.featuredsnippetdirectanswer.fieldtype.md deleted file mode 100644 index c74c841e..00000000 --- a/docs/search-headless.featuredsnippetdirectanswer.fieldtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [fieldType](./search-headless.featuredsnippetdirectanswer.fieldtype.md) - -## FeaturedSnippetDirectAnswer.fieldType property - -The field type of the direct answer. - -Signature: - -```typescript -fieldType: BuiltInFieldType | string; -``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.md b/docs/search-headless.featuredsnippetdirectanswer.md index 6e266059..9469b0fe 100644 --- a/docs/search-headless.featuredsnippetdirectanswer.md +++ b/docs/search-headless.featuredsnippetdirectanswer.md @@ -2,25 +2,14 @@ [Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) -## FeaturedSnippetDirectAnswer interface +## FeaturedSnippetDirectAnswer type -A direct answer which was found within a document. +All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) interfaces. Signature: ```typescript -export declare interface FeaturedSnippetDirectAnswer extends DirectAnswer +export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer; ``` -Extends: [DirectAnswer](./search-headless.directanswer.md)<T> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldType](./search-headless.featuredsnippetdirectanswer.fieldtype.md) | BuiltInFieldType \| string | The field type of the direct answer. | -| [relatedResult](./search-headless.featuredsnippetdirectanswer.relatedresult.md) | [Result](./search-headless.result.md) | The entity associated with the direct answer. | -| [snippet](./search-headless.featuredsnippetdirectanswer.snippet.md) | [Snippet](./search-headless.snippet.md) | The snippet where the direct answer was found. | -| [type](./search-headless.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-headless.directanswertype.md) | [DirectAnswerType](./search-headless.directanswertype.md).FeaturedSnippet. | -| [value?](./search-headless.featuredsnippetdirectanswer.value.md) | T | (Optional) The result of the direct answer. | -| [verticalKey](./search-headless.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | +References: [MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md), [RichTextSnippetDirectAnswer](./search-headless.richtextsnippetdirectanswer.md) diff --git a/docs/search-headless.featuredsnippetdirectanswer.relatedresult.md b/docs/search-headless.featuredsnippetdirectanswer.relatedresult.md deleted file mode 100644 index 6828d3f8..00000000 --- a/docs/search-headless.featuredsnippetdirectanswer.relatedresult.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [relatedResult](./search-headless.featuredsnippetdirectanswer.relatedresult.md) - -## FeaturedSnippetDirectAnswer.relatedResult property - -The entity associated with the direct answer. - -Signature: - -```typescript -relatedResult: Result; -``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.type.md b/docs/search-headless.featuredsnippetdirectanswer.type.md deleted file mode 100644 index 0e970332..00000000 --- a/docs/search-headless.featuredsnippetdirectanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [type](./search-headless.featuredsnippetdirectanswer.type.md) - -## FeaturedSnippetDirectAnswer.type property - -[DirectAnswerType](./search-headless.directanswertype.md).FeaturedSnippet. - -Signature: - -```typescript -type: DirectAnswerType.FeaturedSnippet; -``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.value.md b/docs/search-headless.featuredsnippetdirectanswer.value.md deleted file mode 100644 index 6d812f1f..00000000 --- a/docs/search-headless.featuredsnippetdirectanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [value](./search-headless.featuredsnippetdirectanswer.value.md) - -## FeaturedSnippetDirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value?: T; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/search-headless.featuredsnippetdirectanswer.verticalkey.md b/docs/search-headless.featuredsnippetdirectanswer.verticalkey.md deleted file mode 100644 index c88299da..00000000 --- a/docs/search-headless.featuredsnippetdirectanswer.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [verticalKey](./search-headless.featuredsnippetdirectanswer.verticalkey.md) - -## FeaturedSnippetDirectAnswer.verticalKey property - -The vertical key of the direct answer. - -Signature: - -```typescript -verticalKey: string; -``` diff --git a/docs/search-headless.fieldvaluedirectanswer.fieldtype.md b/docs/search-headless.fieldvaluedirectanswer.fieldtype.md deleted file mode 100644 index f3f32e61..00000000 --- a/docs/search-headless.fieldvaluedirectanswer.fieldtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [fieldType](./search-headless.fieldvaluedirectanswer.fieldtype.md) - -## FieldValueDirectAnswer.fieldType property - -The field type of the direct answer. - -Signature: - -```typescript -fieldType: BuiltInFieldType | string; -``` diff --git a/docs/search-headless.fieldvaluedirectanswer.md b/docs/search-headless.fieldvaluedirectanswer.md index 56c27db3..3a957916 100644 --- a/docs/search-headless.fieldvaluedirectanswer.md +++ b/docs/search-headless.fieldvaluedirectanswer.md @@ -2,27 +2,14 @@ [Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) -## FieldValueDirectAnswer interface +## FieldValueDirectAnswer type -A direct answer where the answer came from a field from the knowledge graph. +Possible built-in and custom [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interfaces. Signature: ```typescript -export declare interface FieldValueDirectAnswer extends DirectAnswer +export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer; ``` -Extends: [DirectAnswer](./search-headless.directanswer.md)<T> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [entityName](./search-headless.fieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | -| [fieldApiName](./search-headless.fieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | -| [fieldName](./search-headless.fieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | -| [fieldType](./search-headless.fieldvaluedirectanswer.fieldtype.md) | BuiltInFieldType \| string | The field type of the direct answer. | -| [relatedResult](./search-headless.fieldvaluedirectanswer.relatedresult.md) | [Result](./search-headless.result.md) | The entity associated with the direct answer. | -| [type](./search-headless.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-headless.directanswertype.md) | [DirectAnswerType](./search-headless.directanswertype.md).FieldValue. | -| [value](./search-headless.fieldvaluedirectanswer.value.md) | T | The result of the direct answer. | -| [verticalKey](./search-headless.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | +References: [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md), [TextDirectAnswer](./search-headless.textdirectanswer.md), [UrlDirectAnswer](./search-headless.urldirectanswer.md), [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md), [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md), [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md), [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md), [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md), [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md), [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md), [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md), [IntegerDirectAnswer](./search-headless.integerdirectanswer.md), [PhoneDirectAnswer](./search-headless.phonedirectanswer.md), [EmailDirectAnswer](./search-headless.emaildirectanswer.md), [AddressDirectAnswer](./search-headless.addressdirectanswer.md) diff --git a/docs/search-headless.fieldvaluedirectanswer.relatedresult.md b/docs/search-headless.fieldvaluedirectanswer.relatedresult.md deleted file mode 100644 index 73967639..00000000 --- a/docs/search-headless.fieldvaluedirectanswer.relatedresult.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [relatedResult](./search-headless.fieldvaluedirectanswer.relatedresult.md) - -## FieldValueDirectAnswer.relatedResult property - -The entity associated with the direct answer. - -Signature: - -```typescript -relatedResult: Result; -``` diff --git a/docs/search-headless.fieldvaluedirectanswer.type.md b/docs/search-headless.fieldvaluedirectanswer.type.md deleted file mode 100644 index f4725c4d..00000000 --- a/docs/search-headless.fieldvaluedirectanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [type](./search-headless.fieldvaluedirectanswer.type.md) - -## FieldValueDirectAnswer.type property - -[DirectAnswerType](./search-headless.directanswertype.md).FieldValue. - -Signature: - -```typescript -type: DirectAnswerType.FieldValue; -``` diff --git a/docs/search-headless.fieldvaluedirectanswer.value.md b/docs/search-headless.fieldvaluedirectanswer.value.md deleted file mode 100644 index 36367537..00000000 --- a/docs/search-headless.fieldvaluedirectanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [value](./search-headless.fieldvaluedirectanswer.value.md) - -## FieldValueDirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value: T; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/search-headless.fieldvaluedirectanswer.verticalkey.md b/docs/search-headless.fieldvaluedirectanswer.verticalkey.md deleted file mode 100644 index f57ba1b1..00000000 --- a/docs/search-headless.fieldvaluedirectanswer.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [verticalKey](./search-headless.fieldvaluedirectanswer.verticalkey.md) - -## FieldValueDirectAnswer.verticalKey property - -The vertical key of the direct answer. - -Signature: - -```typescript -verticalKey: string; -``` diff --git a/docs/search-headless.instagramhandledirectanswer.fieldtype.md b/docs/search-headless.instagramhandledirectanswer.fieldtype.md new file mode 100644 index 00000000..77692493 --- /dev/null +++ b/docs/search-headless.instagramhandledirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md) > [fieldType](./search-headless.instagramhandledirectanswer.fieldtype.md) + +## InstagramHandleDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.instagramhandledirectanswer.md b/docs/search-headless.instagramhandledirectanswer.md new file mode 100644 index 00000000..6cf480cc --- /dev/null +++ b/docs/search-headless.instagramhandledirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md) + +## InstagramHandleDirectAnswer interface + +A direct answer for an instagram handle field. + +Signature: + +```typescript +export declare interface InstagramHandleDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.instagramhandledirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.InstagramHandle](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.integerdirectanswer.fieldtype.md b/docs/search-headless.integerdirectanswer.fieldtype.md new file mode 100644 index 00000000..851d9494 --- /dev/null +++ b/docs/search-headless.integerdirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [IntegerDirectAnswer](./search-headless.integerdirectanswer.md) > [fieldType](./search-headless.integerdirectanswer.fieldtype.md) + +## IntegerDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.integerdirectanswer.md b/docs/search-headless.integerdirectanswer.md new file mode 100644 index 00000000..6ae713b7 --- /dev/null +++ b/docs/search-headless.integerdirectanswer.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [IntegerDirectAnswer](./search-headless.integerdirectanswer.md) + +## IntegerDirectAnswer interface + +A direct answer for an integer field. + +Signature: + +```typescript +export declare interface IntegerDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<number> + +## Remarks + +`IntegerDirectAnswer`s are only used for built in number fields. Custom number fields use [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) instead. + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.integerdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Integer](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.iosappurldirectanswer.fieldtype.md b/docs/search-headless.iosappurldirectanswer.fieldtype.md new file mode 100644 index 00000000..69690cfd --- /dev/null +++ b/docs/search-headless.iosappurldirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md) > [fieldType](./search-headless.iosappurldirectanswer.fieldtype.md) + +## IosAppUrlDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.iosappurldirectanswer.md b/docs/search-headless.iosappurldirectanswer.md new file mode 100644 index 00000000..623cd7ff --- /dev/null +++ b/docs/search-headless.iosappurldirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md) + +## IosAppUrlDirectAnswer interface + +A direct answer for an iOS app url field. + +Signature: + +```typescript +export declare interface IosAppUrlDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.iosappurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.IOSAppURL](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.md b/docs/search-headless.md index 815493eb..3bd3417f 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -19,6 +19,7 @@ | Enumeration | Description | | --- | --- | | [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. | +| [BuiltInFieldType](./search-headless.builtinfieldtype.md) | Possible built-in field types for [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md). | | [DirectAnswerType](./search-headless.directanswertype.md) | Represents the type of direct answer. | | [Direction](./search-headless.direction.md) | The direction of a sort. | | [ErrorType](./search-headless.errortype.md) | Identifier for the type of error causing the failure. | @@ -49,7 +50,9 @@ | Interface | Description | | --- | --- | | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | +| [AddressDirectAnswer](./search-headless.addressdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'address' field type. | | [AllResultsForVertical](./search-headless.allresultsforvertical.md) | Represents all results for the current vertical. | +| [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) | A direct answer for an android app url field. | | [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) | | | [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) | | | [AnswersError](./search-headless.answerserror.md) | | @@ -59,27 +62,34 @@ | [AutocompleteResult](./search-headless.autocompleteresult.md) | An autocomplete suggestion. | | [AutocompleteService](./search-headless.autocompleteservice.md) | A service for autocomplete requests. | | [BaseAnswersConfig](./search-headless.baseanswersconfig.md) | | +| [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) | A direct answer which was found within a document. | +| [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | | [BaseSearchConfig](./search-headless.basesearchconfig.md) | The base configuration options for [SearchCore](./search-headless.searchcore.md). | | [BoundedRange](./search-headless.boundedrange.md) | An interface representing a range of values of type T. | | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | +| [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) | A direct answer for a complex url field. | | [ConjunctionStaticFilter](./search-headless.conjunctionstaticfilter.md) | A static filter composed by combining other static filters with the logical AND operator. | +| [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) | A direct answer for a decimal field, which is a number represented using a string. | | [DirectAnswer](./search-headless.directanswer.md) | A direct answer to a search. | | [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | | [DisjunctionStaticFilter](./search-headless.disjunctionstaticfilter.md) | A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. | | [DisplayableFacet](./search-headless.displayablefacet.md) | A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. | | [DisplayableFacetOption](./search-headless.displayablefacetoption.md) | A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. | +| [EmailDirectAnswer](./search-headless.emaildirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'email' field type. | | [Endpoints](./search-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. | +| [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md) | A direct answer for a facebook url field. | | [Facet](./search-headless.facet.md) | Represents dynamic filter options for the Search API. | | [FacetOption](./search-headless.facetoption.md) | A filter associated with the facet. | | [FailedVertical](./search-headless.failedvertical.md) | Error information from when a vertical fails to return results. | -| [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. | -| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | | [FieldValueFilter](./search-headless.fieldvaluefilter.md) | Represents a filter which compares values to a single field. | | [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) | A [FieldValueFilter](./search-headless.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types. | | [FilterSearchRequest](./search-headless.filtersearchrequest.md) | Options for a filtersearch request. | | [FilterSearchResponse](./search-headless.filtersearchresponse.md) | The response of a filtersearch request. | | [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | | [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. | +| [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md) | A direct answer for an instagram handle field. | +| [IntegerDirectAnswer](./search-headless.integerdirectanswer.md) | A direct answer for an integer field. | +| [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md) | A direct answer for an iOS app url field. | | [LatLong](./search-headless.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | | [LocationBias](./search-headless.locationbias.md) | Information about the user's location. | | [LocationBoundingBox](./search-headless.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | @@ -87,9 +97,11 @@ | [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | | [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | | [MetaState](./search-headless.metastate.md) | Maintains the metadata for Search Headless. | +| [MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. | | [NearFilterValue](./search-headless.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). | | [NumberRangeValue](./search-headless.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). | | [ParentState](./search-headless.parentstate.md) | The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. | +| [PhoneDirectAnswer](./search-headless.phonedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with phone value. | | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) | Data returned from the Search query rules system. | | [QueryRulesState](./search-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | | [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. | @@ -98,6 +110,8 @@ | [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) | Submits a custom question to the Search API. | | [RangeBoundary](./search-headless.rangeboundary.md) | A boundary for a [BoundedRange](./search-headless.boundedrange.md) of type T. | | [Result](./search-headless.result.md) | An individual search result. | +| [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md) | A direct answer for a rich text field. | +| [RichTextSnippetDirectAnswer](./search-headless.richtextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. | | [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) | Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires apiKey. | | [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) | Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires token. | | [SearchParameterField](./search-headless.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | @@ -113,12 +127,16 @@ | [State](./search-headless.state.md) | The state representing a SearchHeadless instance. | | [StateListener](./search-headless.statelistener.md) | Represents a listener for a specific value of type T in the state. | | [StateManager](./search-headless.statemanager.md) | Manages the information contained in the state for a SearchHeadless instance. | +| [TextDirectAnswer](./search-headless.textdirectanswer.md) | A direct answer whose source is a string or string list field in the knowledge graph. | +| [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md) | A direct answer for an twitter handle field. | | [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) | Options for a universal autocomplete request. | | [UniversalLimit](./search-headless.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | | [UniversalSearchRequest](./search-headless.universalsearchrequest.md) | Options which can be specified for a universal search. | | [UniversalSearchResponse](./search-headless.universalsearchresponse.md) | A representation of a response from a universal search. | | [UniversalSearchState](./search-headless.universalsearchstate.md) | Maintains the data for the latest universal search. | +| [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-headless.builtinfieldtype.md). | | [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | +| [UrlDirectAnswer](./search-headless.urldirectanswer.md) | A direct answer for a simple url field. | | [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) | Options for a vertial autocomplete request. | | [VerticalResults](./search-headless.verticalresults.md) | Represents results from a search vertical. | | [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) | Options which can be specified for a vertical search. | @@ -148,6 +166,8 @@ | [AnswersConfig](./search-headless.answersconfig.md) | | | [Context](./search-headless.context.md) | Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | | [EnumOrLiteral](./search-headless.enumorliteral.md) | Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. | +| [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) | All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) interfaces. | +| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | Possible built-in and custom [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interfaces. | | [HeadlessConfig](./search-headless.headlessconfig.md) | The configuration for a SearchHeadless instance. | | [HighlightedFields](./search-headless.highlightedfields.md) | A mapping of fields to the values emphasized by the Search API. | | [SearchConfig](./search-headless.searchconfig.md) | The main configuration options for [SearchCore](./search-headless.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-headless.basesearchconfig.md). The config requires either an apiKey or a token. | diff --git a/docs/search-headless.multilinetextsnippetdirectanswer.fieldtype.md b/docs/search-headless.multilinetextsnippetdirectanswer.fieldtype.md new file mode 100644 index 00000000..380e3f04 --- /dev/null +++ b/docs/search-headless.multilinetextsnippetdirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md) > [fieldType](./search-headless.multilinetextsnippetdirectanswer.fieldtype.md) + +## MultiLineTextSnippetDirectAnswer.fieldType property + +The field type of the direct answer. + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.multilinetextsnippetdirectanswer.md b/docs/search-headless.multilinetextsnippetdirectanswer.md new file mode 100644 index 00000000..4116f549 --- /dev/null +++ b/docs/search-headless.multilinetextsnippetdirectanswer.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md) + +## MultiLineTextSnippetDirectAnswer interface + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. + +Signature: + +```typescript +export declare interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer +``` +Extends: [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.multilinetextsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-headless.builtinfieldtype.md)> | The field type of the direct answer. | +| [value](./search-headless.multilinetextsnippetdirectanswer.value.md) | string | The value of the direct answer. | + diff --git a/docs/search-headless.multilinetextsnippetdirectanswer.value.md b/docs/search-headless.multilinetextsnippetdirectanswer.value.md new file mode 100644 index 00000000..1e1f2f5a --- /dev/null +++ b/docs/search-headless.multilinetextsnippetdirectanswer.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md) > [value](./search-headless.multilinetextsnippetdirectanswer.value.md) + +## MultiLineTextSnippetDirectAnswer.value property + +The value of the direct answer. + +Signature: + +```typescript +value: string; +``` diff --git a/docs/search-headless.phonedirectanswer.fieldtype.md b/docs/search-headless.phonedirectanswer.fieldtype.md new file mode 100644 index 00000000..acd04fcd --- /dev/null +++ b/docs/search-headless.phonedirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [PhoneDirectAnswer](./search-headless.phonedirectanswer.md) > [fieldType](./search-headless.phonedirectanswer.fieldtype.md) + +## PhoneDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: BuiltInFieldType.Phone; +``` diff --git a/docs/search-headless.phonedirectanswer.md b/docs/search-headless.phonedirectanswer.md new file mode 100644 index 00000000..dbf132a4 --- /dev/null +++ b/docs/search-headless.phonedirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [PhoneDirectAnswer](./search-headless.phonedirectanswer.md) + +## PhoneDirectAnswer interface + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with phone value. + +Signature: + +```typescript +export declare interface PhoneDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.phonedirectanswer.fieldtype.md) | [BuiltInFieldType.Phone](./search-headless.builtinfieldtype.md) | | + diff --git a/docs/search-headless.richtextdirectanswer.fieldtype.md b/docs/search-headless.richtextdirectanswer.fieldtype.md new file mode 100644 index 00000000..338f6135 --- /dev/null +++ b/docs/search-headless.richtextdirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md) > [fieldType](./search-headless.richtextdirectanswer.fieldtype.md) + +## RichTextDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.richtextdirectanswer.md b/docs/search-headless.richtextdirectanswer.md new file mode 100644 index 00000000..90c87401 --- /dev/null +++ b/docs/search-headless.richtextdirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md) + +## RichTextDirectAnswer interface + +A direct answer for a rich text field. + +Signature: + +```typescript +export declare interface RichTextDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string \| string\[\]> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.richtextdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.RichText](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.richtextsnippetdirectanswer.fieldtype.md b/docs/search-headless.richtextsnippetdirectanswer.fieldtype.md new file mode 100644 index 00000000..fe604bb3 --- /dev/null +++ b/docs/search-headless.richtextsnippetdirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RichTextSnippetDirectAnswer](./search-headless.richtextsnippetdirectanswer.md) > [fieldType](./search-headless.richtextsnippetdirectanswer.fieldtype.md) + +## RichTextSnippetDirectAnswer.fieldType property + +The field type of the direct answer. + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.richtextsnippetdirectanswer.md b/docs/search-headless.richtextsnippetdirectanswer.md new file mode 100644 index 00000000..e0ce092f --- /dev/null +++ b/docs/search-headless.richtextsnippetdirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RichTextSnippetDirectAnswer](./search-headless.richtextsnippetdirectanswer.md) + +## RichTextSnippetDirectAnswer interface + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. + +Signature: + +```typescript +export declare interface RichTextSnippetDirectAnswer extends Omit, 'value'> +``` +Extends: Omit<[BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md)<string>, 'value'> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.richtextsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.RichText](./search-headless.builtinfieldtype.md)> | The field type of the direct answer. | + diff --git a/docs/search-headless.snippet.matchedsubstrings.md b/docs/search-headless.snippet.matchedsubstrings.md index 76e87f97..1de1c08a 100644 --- a/docs/search-headless.snippet.matchedsubstrings.md +++ b/docs/search-headless.snippet.matchedsubstrings.md @@ -4,7 +4,7 @@ ## Snippet.matchedSubstrings property -The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./search-headless.featuredsnippetdirectanswer.value.md) +The locations in the document text of the [DirectAnswer.value](./search-headless.directanswer.value.md) Signature: diff --git a/docs/search-headless.snippet.md b/docs/search-headless.snippet.md index f2e68469..87926cec 100644 --- a/docs/search-headless.snippet.md +++ b/docs/search-headless.snippet.md @@ -16,6 +16,6 @@ export declare interface Snippet | Property | Type | Description | | --- | --- | --- | -| [matchedSubstrings](./search-headless.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./search-headless.featuredsnippetdirectanswer.value.md) | +| [matchedSubstrings](./search-headless.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [DirectAnswer.value](./search-headless.directanswer.value.md) | | [value](./search-headless.snippet.value.md) | string | The snippet's body of text | diff --git a/docs/search-headless.textdirectanswer.fieldtype.md b/docs/search-headless.textdirectanswer.fieldtype.md new file mode 100644 index 00000000..ae8b1041 --- /dev/null +++ b/docs/search-headless.textdirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [TextDirectAnswer](./search-headless.textdirectanswer.md) > [fieldType](./search-headless.textdirectanswer.fieldtype.md) + +## TextDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.textdirectanswer.md b/docs/search-headless.textdirectanswer.md new file mode 100644 index 00000000..e9751ceb --- /dev/null +++ b/docs/search-headless.textdirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [TextDirectAnswer](./search-headless.textdirectanswer.md) + +## TextDirectAnswer interface + +A direct answer whose source is a string or string list field in the knowledge graph. + +Signature: + +```typescript +export declare interface TextDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string \| string\[\]> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.textdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.SingleLineText](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.MultiLineText](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.twitterhandledirectanswer.fieldtype.md b/docs/search-headless.twitterhandledirectanswer.fieldtype.md new file mode 100644 index 00000000..ca33d373 --- /dev/null +++ b/docs/search-headless.twitterhandledirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md) > [fieldType](./search-headless.twitterhandledirectanswer.fieldtype.md) + +## TwitterHandleDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.twitterhandledirectanswer.md b/docs/search-headless.twitterhandledirectanswer.md new file mode 100644 index 00000000..cbea2573 --- /dev/null +++ b/docs/search-headless.twitterhandledirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md) + +## TwitterHandleDirectAnswer interface + +A direct answer for an twitter handle field. + +Signature: + +```typescript +export declare interface TwitterHandleDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.twitterhandledirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.TwitterHandle](./search-headless.builtinfieldtype.md)> | | + diff --git a/docs/search-headless.unknownfieldvaluedirectanswer.fieldtype.md b/docs/search-headless.unknownfieldvaluedirectanswer.fieldtype.md new file mode 100644 index 00000000..f5f22efe --- /dev/null +++ b/docs/search-headless.unknownfieldvaluedirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md) > [fieldType](./search-headless.unknownfieldvaluedirectanswer.fieldtype.md) + +## UnknownFieldValueDirectAnswer.fieldType property + +The field type of the direct answer. + +Signature: + +```typescript +fieldType: 'unknown'; +``` diff --git a/docs/search-headless.unknownfieldvaluedirectanswer.md b/docs/search-headless.unknownfieldvaluedirectanswer.md new file mode 100644 index 00000000..2660b887 --- /dev/null +++ b/docs/search-headless.unknownfieldvaluedirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md) + +## UnknownFieldValueDirectAnswer interface + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-headless.builtinfieldtype.md). + +Signature: + +```typescript +export declare interface UnknownFieldValueDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<T> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.unknownfieldvaluedirectanswer.fieldtype.md) | 'unknown' | The field type of the direct answer. | + diff --git a/docs/search-headless.urldirectanswer.fieldtype.md b/docs/search-headless.urldirectanswer.fieldtype.md new file mode 100644 index 00000000..a081afc3 --- /dev/null +++ b/docs/search-headless.urldirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UrlDirectAnswer](./search-headless.urldirectanswer.md) > [fieldType](./search-headless.urldirectanswer.fieldtype.md) + +## UrlDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: EnumOrLiteral; +``` diff --git a/docs/search-headless.urldirectanswer.md b/docs/search-headless.urldirectanswer.md new file mode 100644 index 00000000..645075ab --- /dev/null +++ b/docs/search-headless.urldirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UrlDirectAnswer](./search-headless.urldirectanswer.md) + +## UrlDirectAnswer interface + +A direct answer for a simple url field. + +Signature: + +```typescript +export declare interface UrlDirectAnswer extends BaseFieldValueDirectAnswer +``` +Extends: [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<string \| string\[\]> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.urldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.URL](./search-headless.builtinfieldtype.md)> | | + diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md index bb0be5ce..0427faec 100644 --- a/etc/search-headless.api.md +++ b/etc/search-headless.api.md @@ -11,6 +11,16 @@ 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
{ + // Warning: (ae-forgotten-export) The symbol "EnumOrLiteral" needs to be exported by the entry point index.d.ts + // + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export interface AllResultsForVertical { facets: DisplayableFacet[]; @@ -18,6 +28,12 @@ export interface AllResultsForVertical { resultsCount: number; } +// @public +export interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public @deprecated (undocumented) export type AnswersConfig = SearchConfig; @@ -96,6 +112,22 @@ export interface AutocompleteService { export interface BaseAnswersConfig extends BaseSearchConfig { } +// @public +export interface BaseFeaturedSnippetDirectAnswer extends DirectAnswer { + fieldType: EnumOrLiteral_2; + snippet: Snippet; + type: DirectAnswerType.FeaturedSnippet; +} + +// @public +export interface BaseFieldValueDirectAnswer extends DirectAnswer { + entityName: string; + fieldApiName: string; + fieldName: string; + type: DirectAnswerType.FieldValue; + value: T; +} + // @public export interface BaseSearchConfig { endpoints?: Endpoints; @@ -112,6 +144,40 @@ export interface BoundedRange { min?: RangeBoundary; } +// @public +export enum BuiltInFieldType { + // (undocumented) + Address = "address", + // (undocumented) + AndroidAppURL = "android_app_url", + // (undocumented) + ComplexURL = "complex_url", + // (undocumented) + Decimal = "decimal", + // (undocumented) + Email = "email", + // (undocumented) + FacebookURL = "facebook_url", + // (undocumented) + InstagramHandle = "instagram_handle", + // (undocumented) + Integer = "integer", + // (undocumented) + IOSAppURL = "ios_app_url", + // (undocumented) + MultiLineText = "multi_line_text", + // (undocumented) + Phone = "phone", + // (undocumented) + RichText = "rich_text", + // (undocumented) + SingleLineText = "single_line_text", + // (undocumented) + TwitterHandle = "twitter_handle", + // (undocumented) + URL = "url" +} + // @public export interface ClientSDKHeaderValues { [agent: string]: string | undefined; @@ -121,6 +187,14 @@ export interface ClientSDKHeaderValues { // @public export function combineStaticFilters(filterA: StaticFilter, filterB: StaticFilter, combinator: FilterCombinator): StaticFilter; +// Warning: (ae-forgotten-export) The symbol "ComplexURL" needs to be exported by the entry point index.d.ts +// +// @public +export interface ComplexUrlDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export interface ConjunctionStaticFilter { combinator: FilterCombinator.AND; @@ -143,13 +217,18 @@ export function createNearMeStaticFilter(position: NearFilterValue): FieldValueS // @public export function createNumberRangeStaticFilter(fieldId: string, range: BoundedRange): StaticFilter; +// @public +export interface DecimalDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export const DEFAULT_HEADLESS_ID = "main"; // @public export interface DirectAnswer { - // Warning: (ae-forgotten-export) The symbol "BuiltInFieldType" needs to be exported by the entry point index.d.ts - fieldType: BuiltInFieldType | string; + fieldType: EnumOrLiteral_2 | 'unknown'; relatedResult: Result; type: DirectAnswerType; value?: T; @@ -193,6 +272,12 @@ export interface DisplayableFacetOption extends FacetOption { selected: boolean; } +// @public +export interface EmailDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export interface Endpoints { // (undocumented) @@ -222,6 +307,12 @@ export enum ErrorType { Timeout = "TIMEOUT" } +// @public +export interface FacebookUrlDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export interface Facet { fieldId: string; @@ -245,26 +336,10 @@ export interface FailedVertical { } // @public -export interface FeaturedSnippetDirectAnswer extends DirectAnswer { - fieldType: BuiltInFieldType | string; - relatedResult: Result; - snippet: Snippet; - type: DirectAnswerType.FeaturedSnippet; - value?: T; - verticalKey: string; -} +export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer; // @public -export interface FieldValueDirectAnswer extends DirectAnswer { - entityName: string; - fieldApiName: string; - fieldName: string; - fieldType: BuiltInFieldType | string; - relatedResult: Result; - type: DirectAnswerType.FieldValue; - value: T; - verticalKey: string; -} +export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer; // @public export interface FieldValueFilter { @@ -331,6 +406,24 @@ export interface HighlightedValue { value: string; } +// @public +export interface InstagramHandleDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + +// @public +export interface IntegerDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + +// @public +export interface IosAppUrlDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public function isCloseMatch(value: string, searchTerm: string): boolean; @@ -404,6 +497,12 @@ export interface MetaState { uuid?: string; } +// @public +export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer { + fieldType: EnumOrLiteral_2; + value: string; +} + // @public export interface NearFilterValue { lat: number; @@ -422,6 +521,12 @@ export interface ParentState { [headlessId: string]: State; } +// @public +export interface PhoneDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: BuiltInFieldType.Phone; +} + // @public @deprecated export const provideAnswersHeadless: typeof provideHeadless; @@ -513,6 +618,17 @@ export interface Result> { source: Source; } +// @public +export interface RichTextDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + +// @public +export interface RichTextSnippetDirectAnswer extends Omit, 'value'> { + fieldType: EnumOrLiteral_2; +} + // @public export const SandboxEndpoints: Required; @@ -736,6 +852,18 @@ export interface StateManager { // @public export type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter; +// @public +export interface TextDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + +// @public +export interface TwitterHandleDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export interface UniversalAutocompleteRequest extends SearchRequest { input: string; @@ -783,12 +911,23 @@ export interface UniversalSearchState { verticals?: VerticalResults[]; } +// @public +export interface UnknownFieldValueDirectAnswer extends BaseFieldValueDirectAnswer { + fieldType: 'unknown'; +} + // @public export interface UpperNumberRangeLimit { matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; value: number; } +// @public +export interface UrlDirectAnswer extends BaseFieldValueDirectAnswer { + // (undocumented) + fieldType: EnumOrLiteral_2; +} + // @public export interface VerticalAutocompleteRequest extends SearchRequest { input: string; diff --git a/package-lock.json b/package-lock.json index f7e688bc..757d15fe 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,16 +1,16 @@ { "name": "@yext/search-headless", - "version": "2.0.0-alpha.130", + "version": "2.0.0-alpha.131", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@yext/search-headless", - "version": "2.0.0-alpha.130", + "version": "2.0.0-alpha.131", "license": "BSD-3-Clause", "dependencies": { "@reduxjs/toolkit": "^1.8.1", - "@yext/search-core": "^2.0.0-alpha.204", + "@yext/search-core": "^2.0.0-alpha.215", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21" }, @@ -4686,9 +4686,9 @@ } }, "node_modules/@yext/search-core": { - "version": "2.0.0-alpha.204", - "resolved": "https://registry.npmjs.org/@yext/search-core/-/search-core-2.0.0-alpha.204.tgz", - "integrity": "sha512-ouV1ZmqrEmwLXBDjxB/Jou3LbkPmHDAKvSyD9E5beO1D+GOmc8BDkGiQ6c9STgYoXH3L58X+NMHiGf3yFNFWgw==", + "version": "2.0.0-alpha.215", + "resolved": "https://registry.npmjs.org/@yext/search-core/-/search-core-2.0.0-alpha.215.tgz", + "integrity": "sha512-KUB4SFzjmCYFnz2m0z3iPCMKstvbgpzW9gOFdYAscWdq0SNw0+Ch5gPUy3D+4eAPRA0vj7i4/YEL1CEeRtfShA==", "dependencies": { "@babel/runtime-corejs3": "^7.12.5", "cross-fetch": "^3.1.5" @@ -16349,9 +16349,9 @@ } }, "@yext/search-core": { - "version": "2.0.0-alpha.204", - "resolved": "https://registry.npmjs.org/@yext/search-core/-/search-core-2.0.0-alpha.204.tgz", - "integrity": "sha512-ouV1ZmqrEmwLXBDjxB/Jou3LbkPmHDAKvSyD9E5beO1D+GOmc8BDkGiQ6c9STgYoXH3L58X+NMHiGf3yFNFWgw==", + "version": "2.0.0-alpha.215", + "resolved": "https://registry.npmjs.org/@yext/search-core/-/search-core-2.0.0-alpha.215.tgz", + "integrity": "sha512-KUB4SFzjmCYFnz2m0z3iPCMKstvbgpzW9gOFdYAscWdq0SNw0+Ch5gPUy3D+4eAPRA0vj7i4/YEL1CEeRtfShA==", "requires": { "@babel/runtime-corejs3": "^7.12.5", "cross-fetch": "^3.1.5" diff --git a/package.json b/package.json index 2775b6dd..44e37b37 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@yext/search-headless", - "version": "2.0.0-alpha.130", + "version": "2.0.0-alpha.131", "description": "A library for powering UI components for Yext Search integrations", "author": "slapshot@yext.com", "license": "BSD-3-Clause", @@ -29,7 +29,7 @@ }, "dependencies": { "@reduxjs/toolkit": "^1.8.1", - "@yext/search-core": "^2.0.0-alpha.204", + "@yext/search-core": "^2.0.0-alpha.215", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21" }, diff --git a/src/search-core-re-exports.ts b/src/search-core-re-exports.ts index 5dc7abb5..ae609b1a 100644 --- a/src/search-core-re-exports.ts +++ b/src/search-core-re-exports.ts @@ -17,6 +17,7 @@ export { ClientSDKHeaderValues, DirectAnswer, DirectAnswerType, + BuiltInFieldType, Direction, DisjunctionStaticFilter, DisplayableFacet, @@ -26,8 +27,27 @@ export { FailedVertical, Facet, FacetOption, + BaseFeaturedSnippetDirectAnswer, FeaturedSnippetDirectAnswer, + MultiLineTextSnippetDirectAnswer, + RichTextSnippetDirectAnswer, + BaseFieldValueDirectAnswer, FieldValueDirectAnswer, + UnknownFieldValueDirectAnswer, + TextDirectAnswer, + UrlDirectAnswer, + RichTextDirectAnswer, + DecimalDirectAnswer, + FacebookUrlDirectAnswer, + InstagramHandleDirectAnswer, + TwitterHandleDirectAnswer, + IosAppUrlDirectAnswer, + AndroidAppUrlDirectAnswer, + ComplexUrlDirectAnswer, + IntegerDirectAnswer, + PhoneDirectAnswer, + EmailDirectAnswer, + AddressDirectAnswer, FieldValueFilter, FieldValueStaticFilter, FilterCombinator, diff --git a/tests/integration/directanswer.ts b/tests/integration/directanswer.ts index 20915389..6644db06 100644 --- a/tests/integration/directanswer.ts +++ b/tests/integration/directanswer.ts @@ -1,4 +1,4 @@ -import { FeaturedSnippetDirectAnswer, DirectAnswerType, Source } from '@yext/search-core'; +import { FeaturedSnippetDirectAnswer, DirectAnswerType, Source, BuiltInFieldType } from '@yext/search-core'; import { createMockedHeadless } from '../mocks/createMockedHeadless'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; @@ -31,7 +31,7 @@ const featuredSnippedDirectAnswer: FeaturedSnippetDirectAnswer = { source: Source.KnowledgeManager }, verticalKey: 'people', - fieldType: 'c_name', + fieldType: BuiltInFieldType.RichText, snippet: { value: 'Bob', matchedSubstrings: [{ offset: 0, length: 3 }] diff --git a/tests/integration/facets.ts b/tests/integration/facets.ts index 5c919ace..a03347a7 100644 --- a/tests/integration/facets.ts +++ b/tests/integration/facets.ts @@ -7,7 +7,7 @@ it('can select a facet option', () => { const [initialState, facetOption] = createInitialState(false); const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, true); - expect(answers.state.filters.facets[0].options[0]).toEqual({ + expect(answers.state.filters.facets?.[0].options[0]).toEqual({ matcher: Matcher.Equals, value: 'testValue', displayName: 'testDisplayName', @@ -56,7 +56,7 @@ it('handles selecting multiple facetOptions at the same time', () => { initialState.filters.facets[0].options.push({ ...facetOption }); const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, true); - expect(answers.state.filters.facets[0].options).toEqual([ + expect(answers.state.filters.facets?.[0].options).toEqual([ { matcher: Matcher.Equals, value: 'testValue', @@ -78,7 +78,7 @@ it('can unselect a facet option', () => { const [initialState, facetOption] = createInitialState(true); const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, false); - expect(answers.state.filters.facets[0].options[0]).toEqual({ + expect(answers.state.filters.facets?.[0].options[0]).toEqual({ matcher: Matcher.Equals, value: 'testValue', displayName: 'testDisplayName', @@ -179,8 +179,9 @@ it('searchThroughFacet filters facet options correctly', () => { displayName: 'ignore me' }); const answers = createMockedHeadless({}, initialState); - const facet = answers.state.filters.facets[0]; - const searchedFacet = answers.utilities.searchThroughFacet(facet, 'cation'); + const facet = answers.state.filters.facets?.[0]; + expect(facet).toBeDefined(); + const searchedFacet = answers.utilities.searchThroughFacet(facet as DisplayableFacet, 'cation'); expect(searchedFacet).toEqual({ displayName: 'test facet name', fieldId: 'testFieldId', @@ -212,8 +213,9 @@ it('searchThroughFacet filters facet options correctly for similar searchTerm', displayName: 'Cation' }); const answers = createMockedHeadless({}, initialState); - const facet = answers.state.filters.facets[0]; - const searchedFacet = answers.utilities.searchThroughFacet(facet, 'car'); + const facet = answers.state.filters.facets?.[0]; + expect(facet).toBeDefined(); + const searchedFacet = answers.utilities.searchThroughFacet(facet as DisplayableFacet, 'car'); expect(searchedFacet).toEqual({ displayName: 'test facet name', fieldId: 'testFieldId', @@ -249,7 +251,7 @@ it('searchThroughFacet filters facet options correctly for short searchTerm', () displayName: 'ignore me' }); const answers = createMockedHeadless({}, initialState); - const facet = answers.state.filters.facets[0]; + const facet = answers.state.filters.facets?.[0] as DisplayableFacet; const searchedFacet = answers.utilities.searchThroughFacet(facet, 'ca'); expect(searchedFacet).toEqual({ displayName: 'test facet name', @@ -289,14 +291,21 @@ it('can reset facets correctly', () => { const [initialState, ] = createInitialState(true); const answers = createMockedHeadless({}, initialState); answers.resetFacets(); - answers.state.filters.facets.map(facet => + expect(answers.state.filters.facets?.length).toBeGreaterThan(0); + answers.state.filters.facets?.map(facet => facet.options.map(option => expect(option.selected).toBeFalsy()) ); }); +type InitialState = Partial & { + filters: { + facets: [DisplayableFacet, ...DisplayableFacet[]] + } +}; + function createInitialState( facetIsSelected: boolean -): [initialState: Partial, facetOption: DisplayableFacetOption] { +): [initialState: InitialState, facetOption: DisplayableFacetOption] { const facetOption: DisplayableFacetOption = { matcher: Matcher.Equals, value: 'testValue', @@ -309,7 +318,7 @@ function createInitialState( displayName: 'test facet name', options: [facetOption] }; - const initialState: Partial = { + const initialState: InitialState = { query: { input: 'test' }, diff --git a/tests/integration/verticalsearch.ts b/tests/integration/verticalsearch.ts index 596dc509..bddabaa6 100644 --- a/tests/integration/verticalsearch.ts +++ b/tests/integration/verticalsearch.ts @@ -1,4 +1,4 @@ -import { AppliedQueryFilter, Matcher, Result, Source, VerticalResults, VerticalSearchRequest, VerticalSearchResponse } from '@yext/search-core'; +import { AppliedQueryFilter, AppliedQueryFilterType, Matcher, Result, Source, VerticalResults, VerticalSearchRequest, VerticalSearchResponse } from '@yext/search-core'; import HttpManager from '../../src/http-manager'; import { AllResultsForVertical } from '../../src/models/slices/vertical'; import { State } from '../../src/models/state'; @@ -83,6 +83,7 @@ it('vertical searches set appliedQueryFilters', async () => { const mockAppliedQueryFilters: AppliedQueryFilter[] = [{ displayKey: 'tesKey', displayValue: 'testValue', + type: AppliedQueryFilterType.FieldValue, filter: { fieldId: 'test', matcher: Matcher.Equals,