@empathyco/x-components 3.0.0-alpha.93 → 3.0.0-alpha.96

package/CHANGELOG.md

@@ -3,6 +3,53 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0-alpha.96](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.95...@empathyco/x-components@3.0.0-alpha.96) (2022-05-13)
+
+### ⚠ BREAKING CHANGES
+
+- **facets:** Renamed method `registerFilterModifier` in `FilterEntityFactory` to
+  `registerModifierByFacetId`.
+- **facets:** Changed `modifiers` parameter of `registerFilterModifier` in `FilterEntityFactory`
+  from a single array in favour of rest parameters.
+
+### Features
+
+- **facets:** add `registerModifierByFilterModelName`
+  ([36956a1](https://github.com/empathyco/x/commit/36956a13b33cc5430381d33ac53cd33b706136da)),
+  closes [EX-6106](https://searchbroker.atlassian.net/browse/EX-6106)
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [3.0.0-alpha.95](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.94...@empathyco/x-components@3.0.0-alpha.95) (2022-05-11)
+
+### ⚠ BREAKING CHANGES
+
+- Request types moved to `x-types` package. Change the imports from `x-adapter` to `x-type`.
+- Removed `TaggingInfo` type. Use `TaggingRequest` from `@empathyco/x-types` instead.
+
+### Features
+
+- move `Request` types to `x-types` package
+  ([7cc85c1](https://github.com/empathyco/x/commit/7cc85c1d371b604b3188d8cc2076eab5fc9460e4)),
+  closes [EX-6066](https://searchbroker.atlassian.net/browse/EX-6066)
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [3.0.0-alpha.94](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.93...@empathyco/x-components@3.0.0-alpha.94) (2022-05-09)
+
+**Note:** Version bump only for package @empathyco/x-components
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
 ## [3.0.0-alpha.93](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.92...@empathyco/x-components@3.0.0-alpha.93) (2022-05-06)
 
 **Note:** Version bump only for package @empathyco/x-components

package/docs/API-reference/api/x-adapter.empathybannermapper._constructor_.md

@@ -9,12 +9,12 @@ Constructs a new instance of the `EmpathyBannerMapper` class
 <b>Signature:</b>
 
 ```typescript
-constructor(taggingMappers: ResponseMapper<string, TaggingInfo>[]);
+constructor(taggingMappers: ResponseMapper<string, TrackingRequest>[]);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, TaggingInfo&gt;\[\] |  |
+|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, [TrackingRequest](./x-adapter.trackingrequest.md)<!-- -->&gt;\[\] |  |
 

package/docs/API-reference/api/x-adapter.empathypromotedmapper._constructor_.md

@@ -9,12 +9,12 @@ Constructs a new instance of the `EmpathyPromotedMapper` class
 <b>Signature:</b>
 
 ```typescript
-constructor(taggingMappers: ResponseMapper<string, TaggingInfo>[]);
+constructor(taggingMappers: ResponseMapper<string, TrackingRequest>[]);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, TaggingInfo&gt;\[\] |  |
+|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, [TrackingRequest](./x-adapter.trackingrequest.md)<!-- -->&gt;\[\] |  |
 

package/docs/API-reference/api/x-adapter.empathyredirectionmapper._constructor_.md

@@ -9,12 +9,12 @@ Constructs a new instance of the `EmpathyRedirectionMapper` class
 <b>Signature:</b>
 
 ```typescript
-constructor(taggingMappers: ResponseMapper<string, TaggingInfo>[]);
+constructor(taggingMappers: ResponseMapper<string, TrackingRequest>[]);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, TaggingInfo&gt;\[\] |  |
+|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, [TrackingRequest](./x-adapter.trackingrequest.md)<!-- -->&gt;\[\] |  |
 

package/docs/API-reference/api/x-adapter.empathyresultmapper._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `EmpathyResultMapper` class
 <b>Signature:</b>
 
 ```typescript
-constructor(config: EmpathyAdapterConfig, taggingMappers: ResponseMapper<string, TaggingInfo>[]);
+constructor(config: EmpathyAdapterConfig, taggingMappers: ResponseMapper<string, TrackingRequest>[]);
 ```
 
 ## Parameters
@@ -17,5 +17,5 @@ constructor(config: EmpathyAdapterConfig, taggingMappers: ResponseMapper<string,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  config | [EmpathyAdapterConfig](./x-adapter.empathyadapterconfig.md) |  |
-|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, TaggingInfo&gt;\[\] |  |
+|  taggingMappers | [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, [TrackingRequest](./x-adapter.trackingrequest.md)<!-- -->&gt;\[\] |  |
 

package/docs/API-reference/api/x-adapter.empathytaggingmapper.map.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-map(taggingUrl: string, tagging: TaggingInfo): TaggingInfo;
+map(taggingUrl: string, tagging: TrackingRequest): TrackingRequest;
 ```
 
 ## Parameters
@@ -15,9 +15,9 @@ map(taggingUrl: string, tagging: TaggingInfo): TaggingInfo;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  taggingUrl | string |  |
-|  tagging | TaggingInfo |  |
+|  tagging | [TrackingRequest](./x-adapter.trackingrequest.md) |  |
 
 <b>Returns:</b>
 
-TaggingInfo
+[TrackingRequest](./x-adapter.trackingrequest.md)
 

package/docs/API-reference/api/x-adapter.empathytaggingmapper.md

@@ -9,9 +9,9 @@ TODO https://searchbroker.atlassian.net/browse/EX-2163
 <b>Signature:</b>
 
 ```typescript
-export declare class EmpathyTaggingMapper implements ResponseMapper<string, TaggingInfo> 
+export declare class EmpathyTaggingMapper implements ResponseMapper<string, TrackingRequest> 
 ```
-<b>Implements:</b> [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, TaggingInfo&gt;
+<b>Implements:</b> [ResponseMapper](./x-adapter.responsemapper.md)<!-- -->&lt;string, [TrackingRequest](./x-adapter.trackingrequest.md)<!-- -->&gt;
 
 ## Methods
 

package/docs/API-reference/api/x-adapter.searchresponse.md

@@ -20,7 +20,7 @@ export interface SearchResponse
 |  [facets?](./x-adapter.searchresponse.facets.md) | Facet\[\] | <i>(Optional)</i> |
 |  [partialResults?](./x-adapter.searchresponse.partialresults.md) | PartialResult\[\] | <i>(Optional)</i> |
 |  [promoteds?](./x-adapter.searchresponse.promoteds.md) | Promoted\[\] | <i>(Optional)</i> |
-|  [queryTagging](./x-adapter.searchresponse.querytagging.md) | TaggingInfo |  |
+|  [queryTagging](./x-adapter.searchresponse.querytagging.md) | [TrackingRequest](./x-adapter.trackingrequest.md) |  |
 |  [redirections?](./x-adapter.searchresponse.redirections.md) | Redirection\[\] | <i>(Optional)</i> |
 |  [results](./x-adapter.searchresponse.results.md) | Result\[\] |  |
 |  [spellcheck?](./x-adapter.searchresponse.spellcheck.md) | string | <i>(Optional)</i> |

package/docs/API-reference/api/x-adapter.searchresponse.querytagging.md

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-queryTagging: TaggingInfo;
+queryTagging: TrackingRequest;
 ```

package/docs/API-reference/api/x-adapter.trackableshowresponse.md

@@ -16,5 +16,5 @@ export interface TrackableShowResponse
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [showTagging](./x-adapter.trackableshowresponse.showtagging.md) | TaggingInfo |  |
+|  [showTagging](./x-adapter.trackableshowresponse.showtagging.md) | [TrackingRequest](./x-adapter.trackingrequest.md) |  |
 

package/docs/API-reference/api/x-adapter.trackableshowresponse.showtagging.md

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-showTagging: TaggingInfo;
+showTagging: TrackingRequest;
 ```

package/docs/API-reference/api/x-components.fetchandsaveidentifierresults.md

@@ -9,5 +9,5 @@ Default implementation for [IdentifierResultsActions.fetchAndSaveIdentifierResul
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveIdentifierResults: (context: IdentifierResultsActionsContext, request: SearchByIdRequest | null) => void | Promise<void>
+fetchAndSaveIdentifierResults: (context: IdentifierResultsActionsContext, request: IdentifierResultsRequest | null) => void | Promise<void>
 ```

package/docs/API-reference/api/x-components.fetchandsaveidentifierresultswire.md

@@ -9,5 +9,5 @@ Requests and stores a new set of identifier results for the [IdentifierResultsSt
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveIdentifierResultsWire: import("../..").Wire<import("@empathyco/x-adapter").SearchByIdRequest | null>
+fetchAndSaveIdentifierResultsWire: import("../..").Wire<import("@empathyco/x-types").IdentifierResultsRequest | null>
 ```

package/docs/API-reference/api/x-components.fetchandsavenextquerieswire.md

@@ -9,5 +9,5 @@ Requests and stores the next queries.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveNextQueriesWire: import("../..").Wire<import("@empathyco/x-adapter").NextQueriesRequest | null>
+fetchAndSaveNextQueriesWire: import("../..").Wire<import("@empathyco/x-types").NextQueriesRequest | null>
 ```

package/docs/API-reference/api/x-components.fetchandsavepopularsearches.md

@@ -9,5 +9,5 @@ Default implementation for [PopularSearchesActions.fetchAndSaveSuggestions()](./
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveSuggestions: (context: PopularSearchesActionContext, request: SuggestionsRequest) => void | Promise<void>
+fetchAndSaveSuggestions: (context: PopularSearchesActionContext, request: PopularSearchesRequest) => void | Promise<void>
 ```

package/docs/API-reference/api/x-components.fetchandsavequerysuggestions.md

@@ -9,5 +9,5 @@ Default implementation for [QuerySuggestionsActions.fetchAndSaveSuggestions()](.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveSuggestions: (context: QuerySuggestionsActionContext, request: SuggestionsRequest | null) => void | Promise<void>
+fetchAndSaveSuggestions: (context: QuerySuggestionsActionContext, request: QuerySuggestionsRequest | null) => void | Promise<void>
 ```

package/docs/API-reference/api/x-components.fetchandsaverecommendations.md

@@ -9,5 +9,5 @@ Default implementation for [RecommendationsActions.fetchAndSaveRecommendations()
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveRecommendations: (context: RecommendationsActionContext, request: TopRecommendationsRequest | null) => void | Promise<void>
+fetchAndSaveRecommendations: (context: RecommendationsActionContext, request: RecommendationsRequest | null) => void | Promise<void>
 ```

package/docs/API-reference/api/x-components.fetchandsaverelatedtagswire.md

@@ -9,5 +9,5 @@ Requests and stores the related tags.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveRelatedTagsWire: import("../..").Wire<import("@empathyco/x-adapter").RelatedTagsRequest | null>
+fetchAndSaveRelatedTagsWire: import("../..").Wire<import("@empathyco/x-types").RelatedTagsRequest | null>
 ```

package/docs/API-reference/api/x-components.fetchandsavesuggestionswire.md

@@ -9,5 +9,5 @@ Requests and stores a new set of query suggestions for the [QuerySuggestionsStat
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveSuggestionsWire: import("../..").Wire<import("@empathyco/x-adapter").SuggestionsRequest | null>
+fetchAndSaveSuggestionsWire: import("../..").Wire<import("@empathyco/x-types").QuerySuggestionsRequest | null>
 ```

package/docs/API-reference/api/x-components.identifierresultsactions.fetchandsaveidentifierresults.md

@@ -9,14 +9,14 @@ Requests a new set of identifier results and stores them in the module.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveIdentifierResults(request: SearchByIdRequest | null): void;
+fetchAndSaveIdentifierResults(request: IdentifierResultsRequest | null): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | SearchByIdRequest \| null |  |
+|  request | IdentifierResultsRequest \| null |  |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.identifierresultsactions.fetchidentifierresults.md

@@ -9,14 +9,14 @@ Requests a new set of identifier results for the module query, and returns them.
 <b>Signature:</b>
 
 ```typescript
-fetchIdentifierResults(request: SearchByIdRequest | null): Result[];
+fetchIdentifierResults(request: IdentifierResultsRequest | null): Result[];
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | SearchByIdRequest \| null |  |
+|  request | IdentifierResultsRequest \| null |  |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.identifierresultsgetters.identifierresultsrequest.md

@@ -9,5 +9,5 @@ The adapter request object for retrieving the identifier suggestions, or null if
 <b>Signature:</b>
 
 ```typescript
-identifierResultsRequest: SearchByIdRequest | null;
+identifierResultsRequest: IdentifierResultsRequest | null;
 ```

package/docs/API-reference/api/x-components.identifierresultsgetters.md

@@ -18,5 +18,5 @@ export interface IdentifierResultsGetters
 |  --- | --- | --- |
 |  [identifierDetectionRegexp](./x-components.identifierresultsgetters.identifierdetectionregexp.md) | RegExp | The RegExp to test against the query. |
 |  [identifierHighlightRegexp](./x-components.identifierresultsgetters.identifierhighlightregexp.md) | RegExp | The RegExp with the current query from the state adding the separatorChars after each matching character. |
-|  [identifierResultsRequest](./x-components.identifierresultsgetters.identifierresultsrequest.md) | SearchByIdRequest \| null | The adapter request object for retrieving the identifier suggestions, or null if there is not valid data to create a request. |
+|  [identifierResultsRequest](./x-components.identifierresultsgetters.identifierresultsrequest.md) | IdentifierResultsRequest \| null | The adapter request object for retrieving the identifier suggestions, or null if there is not valid data to create a request. |
 

package/docs/API-reference/api/x-components.identifierresultsxevents.identifierresultschanged.md

@@ -4,7 +4,7 @@
 
 ## IdentifierResultsXEvents.IdentifierResultsChanged property
 
-Identifier results have been changed. \* Payload: The new [identifier results](./x-types.result.md)<!-- -->.
+Identifier results have been changed. Payload: The new [identifier results](./x-types.result.md)<!-- -->.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.identifierresultsxevents.identifierresultsrequestchanged.md

@@ -4,10 +4,10 @@
 
 ## IdentifierResultsXEvents.IdentifierResultsRequestChanged property
 
-Any property of the identifier results request has changed. \* Payload: The new [identifier result request](./x-adapter.searchbyidrequest.md) or `null` if there is not enough data in the state nto conform a valid request.
+Any property of the identifier results request has changed. Payload: The new [identifier result request](./x-types.identifierresultsrequest.md) or `null` if there is not enough data in the state nto conform a valid request.
 
 <b>Signature:</b>
 
 ```typescript
-IdentifierResultsRequestChanged: SearchByIdRequest | null;
+IdentifierResultsRequestChanged: IdentifierResultsRequest | null;
 ```

package/docs/API-reference/api/x-components.identifierresultsxevents.md

@@ -16,7 +16,7 @@ export interface IdentifierResultsXEvents
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [IdentifierResultsChanged](./x-components.identifierresultsxevents.identifierresultschanged.md) | Result\[\] | Identifier results have been changed. \* Payload: The new [identifier results](./x-types.result.md)<!-- -->. |
-|  [IdentifierResultsRequestChanged](./x-components.identifierresultsxevents.identifierresultsrequestchanged.md) | SearchByIdRequest \| null | Any property of the identifier results request has changed. \* Payload: The new [identifier result request](./x-adapter.searchbyidrequest.md) or <code>null</code> if there is not enough data in the state nto conform a valid request. |
-|  [UserClickedAIdentifierResult](./x-components.identifierresultsxevents.userclickedaidentifierresult.md) | Result | A identifier result has been clicked. \* Payload: The [result](./x-types.result.md)<!-- -->. |
+|  [IdentifierResultsChanged](./x-components.identifierresultsxevents.identifierresultschanged.md) | Result\[\] | Identifier results have been changed. Payload: The new [identifier results](./x-types.result.md)<!-- -->. |
+|  [IdentifierResultsRequestChanged](./x-components.identifierresultsxevents.identifierresultsrequestchanged.md) | IdentifierResultsRequest \| null | Any property of the identifier results request has changed. Payload: The new [identifier result request](./x-types.identifierresultsrequest.md) or <code>null</code> if there is not enough data in the state nto conform a valid request. |
+|  [UserClickedAIdentifierResult](./x-components.identifierresultsxevents.userclickedaidentifierresult.md) | Result | A identifier result has been clicked. Payload: The [result](./x-types.result.md)<!-- -->. |
 

package/docs/API-reference/api/x-components.identifierresultsxevents.userclickedaidentifierresult.md

@@ -4,7 +4,7 @@
 
 ## IdentifierResultsXEvents.UserClickedAIdentifierResult property
 
-A identifier result has been clicked. \* Payload: The [result](./x-types.result.md)<!-- -->.
+A identifier result has been clicked. Payload: The [result](./x-types.result.md)<!-- -->.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.nextqueriesxevents.md

@@ -16,8 +16,8 @@ export interface NextQueriesXEvents
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [NextQueriesChanged](./x-components.nextqueriesxevents.nextquerieschanged.md) | NextQuery\[\] | Next Queries have been changed. \* Payload: The new [next queries](./x-types.nextquery.md)<!-- -->. |
-|  [NextQueriesDisplayed](./x-components.nextqueriesxevents.nextqueriesdisplayed.md) | NextQuery\[\] | The current next queries have been displayed to the user. \* Payload: The displayed next queries. |
-|  [NextQueriesRequestChanged](./x-components.nextqueriesxevents.nextqueriesrequestchanged.md) | NextQueriesRequest \| null | Any property of the next-queries request has changed \* Payload: The new next-queries request or <code>null</code> if there is not enough data in the state to conform a valid request. |
-|  [UserSelectedANextQuery](./x-components.nextqueriesxevents.userselectedanextquery.md) | NextQuery | The user has selected a next-query \* Payload: The next query that has been selected by the user. |
+|  [NextQueriesChanged](./x-components.nextqueriesxevents.nextquerieschanged.md) | NextQuery\[\] | Next Queries have been changed. Payload: The new [next queries](./x-types.nextquery.md)<!-- -->. |
+|  [NextQueriesDisplayed](./x-components.nextqueriesxevents.nextqueriesdisplayed.md) | NextQuery\[\] | The current next queries have been displayed to the user. Payload: The displayed next queries. |
+|  [NextQueriesRequestChanged](./x-components.nextqueriesxevents.nextqueriesrequestchanged.md) | NextQueriesRequest \| null | Any property of the next-queries request has changed Payload: The new next-queries request or <code>null</code> if there is not enough data in the state to conform a valid request. |
+|  [UserSelectedANextQuery](./x-components.nextqueriesxevents.userselectedanextquery.md) | NextQuery | The user has selected a next-query Payload: The next query that has been selected by the user. |
 

package/docs/API-reference/api/x-components.nextqueriesxevents.nextquerieschanged.md

@@ -4,7 +4,7 @@
 
 ## NextQueriesXEvents.NextQueriesChanged property
 
-Next Queries have been changed. \* Payload: The new [next queries](./x-types.nextquery.md)<!-- -->.
+Next Queries have been changed. Payload: The new [next queries](./x-types.nextquery.md)<!-- -->.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.nextqueriesxevents.nextqueriesdisplayed.md

@@ -4,7 +4,7 @@
 
 ## NextQueriesXEvents.NextQueriesDisplayed property
 
-The current next queries have been displayed to the user. \* Payload: The displayed next queries.
+The current next queries have been displayed to the user. Payload: The displayed next queries.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.nextqueriesxevents.nextqueriesrequestchanged.md

@@ -4,7 +4,7 @@
 
 ## NextQueriesXEvents.NextQueriesRequestChanged property
 
-Any property of the next-queries request has changed \* Payload: The new next-queries request or `null` if there is not enough data in the state to conform a valid request.
+Any property of the next-queries request has changed Payload: The new next-queries request or `null` if there is not enough data in the state to conform a valid request.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.nextqueriesxevents.userselectedanextquery.md

@@ -4,7 +4,7 @@
 
 ## NextQueriesXEvents.UserSelectedANextQuery property
 
-The user has selected a next-query \* Payload: The next query that has been selected by the user.
+The user has selected a next-query Payload: The next query that has been selected by the user.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.popularsearchesactions.fetchandsavesuggestions.md

@@ -9,14 +9,14 @@ Fetches a new set of suggestions and stores them in the module state.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveSuggestions(request: SuggestionsRequest): void;
+fetchAndSaveSuggestions(request: PopularSearchesRequest): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | SuggestionsRequest |  |
+|  request | PopularSearchesRequest |  |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.popularsearchesactions.fetchsuggestions.md

@@ -9,14 +9,14 @@ Fetches a new set of suggestions and returns them.
 <b>Signature:</b>
 
 ```typescript
-fetchSuggestions(request: SuggestionsRequest): Suggestion[];
+fetchSuggestions(request: PopularSearchesRequest): Suggestion[];
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | SuggestionsRequest |  |
+|  request | PopularSearchesRequest |  |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.popularsearchesgetters.md

@@ -17,5 +17,5 @@ export interface PopularSearchesGetters
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [popularSearches](./x-components.popularsearchesgetters.popularsearches.md) | Suggestion\[\] | List of the Popular Searches. |
-|  [request](./x-components.popularsearchesgetters.request.md) | SuggestionsRequest | The request object to retrieve popular searches. |
+|  [request](./x-components.popularsearchesgetters.request.md) | PopularSearchesRequest | The request object to retrieve popular searches. |
 

package/docs/API-reference/api/x-components.popularsearchesgetters.request.md

@@ -9,5 +9,5 @@ The request object to retrieve popular searches.
 <b>Signature:</b>
 
 ```typescript
-request: SuggestionsRequest;
+request: PopularSearchesRequest;
 ```

package/docs/API-reference/api/x-components.popularsearchesxevents.md

@@ -16,7 +16,7 @@ export interface PopularSearchesXEvents
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [PopularSearchDisplayed](./x-components.popularsearchesxevents.popularsearchdisplayed.md) | Suggestion\[\] | The popular searches have been displayed. \* Payload: The displayed [popular searches](./x-types.suggestion.md)<!-- -->. |
-|  [PopularSearchesRequestChanged](./x-components.popularsearchesxevents.popularsearchesrequestchanged.md) | SuggestionsRequest | Any property of the popular-searches request has changed \* Payload: The new popular-search request. |
-|  [UserSelectedAPopularSearch](./x-components.popularsearchesxevents.userselectedapopularsearch.md) | Suggestion | User selected a popular search \* Payload: The popular search that the user selected. |
+|  [PopularSearchDisplayed](./x-components.popularsearchesxevents.popularsearchdisplayed.md) | Suggestion\[\] | The popular searches have been displayed. Payload: The displayed [popular searches](./x-types.suggestion.md)<!-- -->. |
+|  [PopularSearchesRequestChanged](./x-components.popularsearchesxevents.popularsearchesrequestchanged.md) | PopularSearchesRequest | Any property of the popular-searches request has changed Payload: The new popular-search request. |
+|  [UserSelectedAPopularSearch](./x-components.popularsearchesxevents.userselectedapopularsearch.md) | Suggestion | User selected a popular search Payload: The popular search that the user selected. |
 

package/docs/API-reference/api/x-components.popularsearchesxevents.popularsearchdisplayed.md

@@ -4,7 +4,7 @@
 
 ## PopularSearchesXEvents.PopularSearchDisplayed property
 
-The popular searches have been displayed. \* Payload: The displayed [popular searches](./x-types.suggestion.md)<!-- -->.
+The popular searches have been displayed. Payload: The displayed [popular searches](./x-types.suggestion.md)<!-- -->.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.popularsearchesxevents.popularsearchesrequestchanged.md

@@ -4,10 +4,10 @@
 
 ## PopularSearchesXEvents.PopularSearchesRequestChanged property
 
-Any property of the popular-searches request has changed \* Payload: The new popular-search request.
+Any property of the popular-searches request has changed Payload: The new popular-search request.
 
 <b>Signature:</b>
 
 ```typescript
-PopularSearchesRequestChanged: SuggestionsRequest;
+PopularSearchesRequestChanged: PopularSearchesRequest;
 ```

package/docs/API-reference/api/x-components.popularsearchesxevents.userselectedapopularsearch.md

@@ -4,7 +4,7 @@
 
 ## PopularSearchesXEvents.UserSelectedAPopularSearch property
 
-User selected a popular search \* Payload: The popular search that the user selected.
+User selected a popular search Payload: The popular search that the user selected.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.querysuggestionsactions.fetchandsavesuggestions.md

@@ -9,14 +9,14 @@ Requests and saves to the state a list of suggestions.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveSuggestions(request: SuggestionsRequest | null): void;
+fetchAndSaveSuggestions(request: QuerySuggestionsRequest | null): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | SuggestionsRequest \| null |  |
+|  request | QuerySuggestionsRequest \| null |  |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.querysuggestionsactions.fetchsuggestions.md

@@ -9,14 +9,14 @@ Requests and returns a list of suggestions based on the module state.
 <b>Signature:</b>
 
 ```typescript
-fetchSuggestions(request: SuggestionsRequest | null): Suggestion[];
+fetchSuggestions(request: QuerySuggestionsRequest | null): Suggestion[];
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | SuggestionsRequest \| null |  |
+|  request | QuerySuggestionsRequest \| null |  |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.querysuggestionsgetters.md

@@ -18,5 +18,5 @@ export interface QuerySuggestionsGetters
 |  --- | --- | --- |
 |  [normalizedQuery](./x-components.querysuggestionsgetters.normalizedquery.md) | string | The normalized module's query. |
 |  [querySuggestions](./x-components.querysuggestionsgetters.querysuggestions.md) | Suggestion\[\] | The full list of queries suggestions related to the query search. |
-|  [request](./x-components.querysuggestionsgetters.request.md) | SuggestionsRequest \| null | The adapter request object for retrieving the query suggestions, or null if there is not valid data to create a request. |
+|  [request](./x-components.querysuggestionsgetters.request.md) | QuerySuggestionsRequest \| null | The adapter request object for retrieving the query suggestions, or null if there is not valid data to create a request. |
 

package/docs/API-reference/api/x-components.querysuggestionsgetters.request.md

@@ -9,5 +9,5 @@ The adapter request object for retrieving the query suggestions, or null if ther
 <b>Signature:</b>
 
 ```typescript
-request: SuggestionsRequest | null;
+request: QuerySuggestionsRequest | null;
 ```

package/docs/API-reference/api/x-components.querysuggestionsxevents.md

@@ -16,8 +16,8 @@ export interface QuerySuggestionsXEvents
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [QuerySuggestionsChanged](./x-components.querysuggestionsxevents.querysuggestionschanged.md) | Suggestion\[\] | Query suggestions have been changed. \* Payload: The new [query suggestions](./x-types.suggestion.md)<!-- -->. |
-|  [QuerySuggestionsDisplayed](./x-components.querysuggestionsxevents.querysuggestionsdisplayed.md) | Suggestion\[\] | The query suggestions have been displayed. \* Payload: The displayed [query suggestions](./x-types.suggestion.md)<!-- -->. |
-|  [QuerySuggestionsRequestChanged](./x-components.querysuggestionsxevents.querysuggestionsrequestchanged.md) | SuggestionsRequest \| null | Any property of the query-suggestions request has changed. \* Payload: The new query suggestions request or <code>null</code> if there is not enough data in the state to conform a valid request. |
-|  [UserSelectedAQuerySuggestion](./x-components.querysuggestionsxevents.userselectedaquerysuggestion.md) | Suggestion | User selected a query suggestion \* Payload: The [query suggestion](./x-types.suggestion.md) that the user selected. |
+|  [QuerySuggestionsChanged](./x-components.querysuggestionsxevents.querysuggestionschanged.md) | Suggestion\[\] | Query suggestions have been changed. Payload: The new [query suggestions](./x-types.suggestion.md)<!-- -->. |
+|  [QuerySuggestionsDisplayed](./x-components.querysuggestionsxevents.querysuggestionsdisplayed.md) | Suggestion\[\] | The query suggestions have been displayed. Payload: The displayed [query suggestions](./x-types.suggestion.md)<!-- -->. |
+|  [QuerySuggestionsRequestChanged](./x-components.querysuggestionsxevents.querysuggestionsrequestchanged.md) | QuerySuggestionsRequest \| null | Any property of the query-suggestions request has changed. Payload: The new query suggestions request or <code>null</code> if there is not enough data in the state to conform a valid request. |
+|  [UserSelectedAQuerySuggestion](./x-components.querysuggestionsxevents.userselectedaquerysuggestion.md) | Suggestion | User selected a query suggestion Payload: The [query suggestion](./x-types.suggestion.md) that the user selected. |
 

package/docs/API-reference/api/x-components.querysuggestionsxevents.querysuggestionschanged.md

@@ -4,7 +4,7 @@
 
 ## QuerySuggestionsXEvents.QuerySuggestionsChanged property
 
-Query suggestions have been changed. \* Payload: The new [query suggestions](./x-types.suggestion.md)<!-- -->.
+Query suggestions have been changed. Payload: The new [query suggestions](./x-types.suggestion.md)<!-- -->.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.querysuggestionsxevents.querysuggestionsdisplayed.md

@@ -4,7 +4,7 @@
 
 ## QuerySuggestionsXEvents.QuerySuggestionsDisplayed property
 
-The query suggestions have been displayed. \* Payload: The displayed [query suggestions](./x-types.suggestion.md)<!-- -->.
+The query suggestions have been displayed. Payload: The displayed [query suggestions](./x-types.suggestion.md)<!-- -->.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.querysuggestionsxevents.querysuggestionsrequestchanged.md

@@ -4,10 +4,10 @@
 
 ## QuerySuggestionsXEvents.QuerySuggestionsRequestChanged property
 
-Any property of the query-suggestions request has changed. \* Payload: The new query suggestions request or `null` if there is not enough data in the state to conform a valid request.
+Any property of the query-suggestions request has changed. Payload: The new query suggestions request or `null` if there is not enough data in the state to conform a valid request.
 
 <b>Signature:</b>
 
 ```typescript
-QuerySuggestionsRequestChanged: SuggestionsRequest | null;
+QuerySuggestionsRequestChanged: QuerySuggestionsRequest | null;
 ```