Skip to content

Commit

Permalink
Version 2.0.0 (#137)
Browse files Browse the repository at this point in the history
## Version 2.0.0

### Breaking Changes
- Re-exported all modified and newly added direct answer related interfaces from search-core V2. (#131 #133 #136 ) 
  - More details of the changes are listed in [search-core v2 release notes](https://github.com/yext/search-core/releases/tag/v2.0.0)
- Restructured static filters state to allow user to store more complex combination of static filters as well as field value filters. `SelectableFilter` interface is replaced with `SelectableStaticFilter`, which uses the new `StaticFilter` interface from search-core V2. The static filters state now accepts an array of `SelectableStaticFilter`. (#130 )
- All exports marked as `@deprecated` in previous version(s) as part of a rebranding process is now removed in V2 (#132  )
  - for more details, the removed deprecated identifiers are listed in [v1.3 release notes](https://github.com/yext/search-headless/releases/tag/v1.3.0)
  • Loading branch information
yen-tt authored Sep 8, 2022
1 parent 0b91808 commit da09152
Show file tree
Hide file tree
Showing 203 changed files with 2,863 additions and 1,180 deletions.
2 changes: 1 addition & 1 deletion THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ SOFTWARE.

The following NPM package may be included in this product:

- @yext/search-core@1.9.0
- @yext/search-core@2.0.0

This package contains the following license and notice below:

Expand Down
11 changes: 11 additions & 0 deletions docs/search-headless.address.city.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [city](./search-headless.address.city.md)

## Address.city property

<b>Signature:</b>

```typescript
city?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.countrycode.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [countryCode](./search-headless.address.countrycode.md)

## Address.countryCode property

<b>Signature:</b>

```typescript
countryCode: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.extradescription.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [extraDescription](./search-headless.address.extradescription.md)

## Address.extraDescription property

<b>Signature:</b>

```typescript
extraDescription?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.line1.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [line1](./search-headless.address.line1.md)

## Address.line1 property

<b>Signature:</b>

```typescript
line1?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.line2.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [line2](./search-headless.address.line2.md)

## Address.line2 property

<b>Signature:</b>

```typescript
line2?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.line3.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [line3](./search-headless.address.line3.md)

## Address.line3 property

<b>Signature:</b>

```typescript
line3?: string;
```
28 changes: 28 additions & 0 deletions docs/search-headless.address.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md)

## Address interface

An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare interface Address
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [city?](./search-headless.address.city.md) | string | <i>(Optional)</i> |
| [countryCode](./search-headless.address.countrycode.md) | string | |
| [extraDescription?](./search-headless.address.extradescription.md) | string | <i>(Optional)</i> |
| [line1?](./search-headless.address.line1.md) | string | <i>(Optional)</i> |
| [line2?](./search-headless.address.line2.md) | string | <i>(Optional)</i> |
| [line3?](./search-headless.address.line3.md) | string | <i>(Optional)</i> |
| [postalCode?](./search-headless.address.postalcode.md) | string | <i>(Optional)</i> |
| [region?](./search-headless.address.region.md) | string | <i>(Optional)</i> |
| [sublocality?](./search-headless.address.sublocality.md) | string | <i>(Optional)</i> |

11 changes: 11 additions & 0 deletions docs/search-headless.address.postalcode.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [postalCode](./search-headless.address.postalcode.md)

## Address.postalCode property

<b>Signature:</b>

```typescript
postalCode?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.region.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [region](./search-headless.address.region.md)

## Address.region property

<b>Signature:</b>

```typescript
region?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.address.sublocality.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [Address](./search-headless.address.md) &gt; [sublocality](./search-headless.address.sublocality.md)

## Address.sublocality property

<b>Signature:</b>

```typescript
sublocality?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.addressdirectanswer.fieldtype.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [AddressDirectAnswer](./search-headless.addressdirectanswer.md) &gt; [fieldType](./search-headless.addressdirectanswer.fieldtype.md)

## AddressDirectAnswer.fieldType property

<b>Signature:</b>

```typescript
fieldType: EnumOrLiteral<BuiltInFieldType.Address>;
```
21 changes: 21 additions & 0 deletions docs/search-headless.addressdirectanswer.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [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)<!-- -->&lt;[Address](./search-headless.address.md)<!-- -->&gt;
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-headless.addressdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Address](./search-headless.builtinfieldtype.md)<!-- -->&gt; | |
11 changes: 11 additions & 0 deletions docs/search-headless.androidappurldirectanswer.fieldtype.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) &gt; [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md)

## AndroidAppUrlDirectAnswer.fieldType property

<b>Signature:</b>

```typescript
fieldType: EnumOrLiteral<BuiltInFieldType.AndroidAppURL>;
```
21 changes: 21 additions & 0 deletions docs/search-headless.androidappurldirectanswer.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [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)<!-- -->&lt;string&gt;
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.AndroidAppURL](./search-headless.builtinfieldtype.md)<!-- -->&gt; | |
18 changes: 0 additions & 18 deletions docs/search-headless.answersconfig.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/search-headless.answersconfigwithapikey.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/search-headless.answersconfigwithtoken.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/search-headless.answerscore.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/search-headless.answerserror.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/search-headless.answersheadless.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/search-headless.answersrequest.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/search-headless.answersutilities.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/search-headless.appliedqueryfilter.filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ The filter applied to the query results.
<b>Signature:</b>

```typescript
filter: Filter;
filter: FieldValueFilter;
```
2 changes: 1 addition & 1 deletion docs/search-headless.appliedqueryfilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ export declare interface AppliedQueryFilter
| [details?](./search-headless.appliedqueryfilter.details.md) | [LocationFilterDetails](./search-headless.locationfilterdetails.md) | <i>(Optional)</i> Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md)<!-- -->. |
| [displayKey](./search-headless.appliedqueryfilter.displaykey.md) | string | The display name of the filter key. |
| [displayValue](./search-headless.appliedqueryfilter.displayvalue.md) | string | The value used in the filter. |
| [filter](./search-headless.appliedqueryfilter.filter.md) | [Filter](./search-headless.filter.md) | The filter applied to the query results. |
| [filter](./search-headless.appliedqueryfilter.filter.md) | [FieldValueFilter](./search-headless.fieldvaluefilter.md) | The filter applied to the query results. |
| [type](./search-headless.appliedqueryfilter.type.md) | [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. |

2 changes: 1 addition & 1 deletion docs/search-headless.autocompleteresult.filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A filter applied to the autocomplete response.
<b>Signature:</b>

```typescript
filter?: Filter;
filter?: FieldValueFilter;
```

## Remarks
Expand Down
2 changes: 1 addition & 1 deletion docs/search-headless.autocompleteresult.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export declare interface AutocompleteResult

| Property | Type | Description |
| --- | --- | --- |
| [filter?](./search-headless.autocompleteresult.filter.md) | [Filter](./search-headless.filter.md) | <i>(Optional)</i> A filter applied to the autocomplete response. |
| [filter?](./search-headless.autocompleteresult.filter.md) | [FieldValueFilter](./search-headless.fieldvaluefilter.md) | <i>(Optional)</i> A filter applied to the autocomplete response. |
| [key?](./search-headless.autocompleteresult.key.md) | string | <i>(Optional)</i> The fieldId which corresponds to the AutocompleteResult value. |
| [matchedSubstrings?](./search-headless.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | <i>(Optional)</i> An array of substrings which overlap with the autocomplete input. |
| [relatedItem?](./search-headless.autocompleteresult.relateditem.md) | [Result](./search-headless.result.md) | <i>(Optional)</i> An entity that corresponds to the autocomplete result. |
Expand Down
Loading

0 comments on commit da09152

Please sign in to comment.