@empathyco/x-components 3.0.0-alpha.112 → 3.0.0-alpha.113

package/docs/API-reference/api/x-adapter-platform.recommendationsresponsemutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [recommendationsResponseMutableSchema](./x-adapter-platform.recommendationsresponsemutableschema.md)
+
+## recommendationsResponseMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+recommendationsResponseMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformRecommendationsResponse, RecommendationsResponse>>
+```

package/docs/API-reference/api/x-adapter-platform.redirectionmutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [redirectionMutableSchema](./x-adapter-platform.redirectionmutableschema.md)
+
+## redirectionMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+redirectionMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformRedirection, Redirection>>
+```

package/docs/API-reference/api/x-adapter-platform.relatedtagmutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedTagMutableSchema](./x-adapter-platform.relatedtagmutableschema.md)
+
+## relatedTagMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+relatedTagMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformRelatedTag, RelatedTag>>
+```

package/docs/API-reference/api/x-adapter-platform.relatedtagsendpointadapter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedTagsEndpointAdapter](./x-adapter-platform.relatedtagsendpointadapter.md)
+
+## relatedTagsEndpointAdapter variable
+
+This endpoint does not support pagination in the request.
+
+<b>Signature:</b>
+
+```typescript
+relatedTagsEndpointAdapter: import("@empathyco/x-adapter-next").ExtendableEndpointAdapter<RelatedTagsRequest, RelatedTagsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.relatedtagsrequestmapper.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedTagsRequestMapper](./x-adapter-platform.relatedtagsrequestmapper.md)
+
+## relatedTagsRequestMapper variable
+
+<b>Signature:</b>
+
+```typescript
+relatedTagsRequestMapper: import("@empathyco/x-adapter-next").Mapper<RelatedTagsRequest, PlatformRelatedTagsRequest>
+```

package/docs/API-reference/api/x-adapter-platform.relatedtagsrequestmutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedTagsRequestMutableSchema](./x-adapter-platform.relatedtagsrequestmutableschema.md)
+
+## relatedTagsRequestMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+relatedTagsRequestMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<RelatedTagsRequest, PlatformRelatedTagsRequest>>
+```

package/docs/API-reference/api/x-adapter-platform.relatedtagsresponsemapper.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedTagsResponseMapper](./x-adapter-platform.relatedtagsresponsemapper.md)
+
+## relatedTagsResponseMapper variable
+
+<b>Signature:</b>
+
+```typescript
+relatedTagsResponseMapper: import("@empathyco/x-adapter-next").Mapper<PlatformRelatedTagsResponse, RelatedTagsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.relatedtagsresponsemutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedTagsResponseMutableSchema](./x-adapter-platform.relatedtagsresponsemutableschema.md)
+
+## relatedTagsResponseMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+relatedTagsResponseMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformRelatedTagsResponse, RelatedTagsResponse>>
+```

package/docs/API-reference/api/x-adapter-platform.resultschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [resultSchema](./x-adapter-platform.resultschema.md)
+
+## resultSchema variable
+
+<b>Signature:</b>
+
+```typescript
+resultSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformResult, Result>>
+```

package/docs/API-reference/api/x-adapter-platform.searchendpointadapter.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [searchEndpointAdapter](./x-adapter-platform.searchendpointadapter.md)
+
+## searchEndpointAdapter variable
+
+<b>Signature:</b>
+
+```typescript
+searchEndpointAdapter: import("@empathyco/x-adapter-next").ExtendableEndpointAdapter<SearchRequest, SearchResponse>
+```

package/docs/API-reference/api/x-adapter-platform.searchrequestmapper.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [searchRequestMapper](./x-adapter-platform.searchrequestmapper.md)
+
+## searchRequestMapper variable
+
+<b>Signature:</b>
+
+```typescript
+searchRequestMapper: import("@empathyco/x-adapter-next").Mapper<SearchRequest, PlatformSearchRequest>
+```

package/docs/API-reference/api/x-adapter-platform.searchrequestmutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [searchRequestMutableSchema](./x-adapter-platform.searchrequestmutableschema.md)
+
+## searchRequestMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+searchRequestMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<SearchRequest, PlatformSearchRequest>>
+```

package/docs/API-reference/api/x-adapter-platform.searchresponsefacetsmapper.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [searchResponseFacetsMapper](./x-adapter-platform.searchresponsefacetsmapper.md)
+
+## searchResponseFacetsMapper() function
+
+Mapper to flatten hierarchical facet filters.
+
+<b>Signature:</b>
+
+```typescript
+export declare function searchResponseFacetsMapper(from: PlatformSearchResponse, { mappedValue }: MapperContext): Partial<SearchResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  from | [PlatformSearchResponse](./x-adapter-platform.platformsearchresponse.md) | The Platform search response. |
+|  { mappedValue } | MapperContext |  |
+
+<b>Returns:</b>
+
+Partial&lt;SearchResponse&gt;
+
+The mapped facets.
+

package/docs/API-reference/api/x-adapter-platform.searchresponsemapper.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [searchResponseMapper](./x-adapter-platform.searchresponsemapper.md)
+
+## searchResponseMapper variable
+
+<b>Signature:</b>
+
+```typescript
+searchResponseMapper: import("@empathyco/x-adapter-next").Mapper<PlatformSearchResponse, {
+    banners: import("@empathyco/x-types").Banner[];
+    facets: import("@empathyco/x-types").Facet[];
+    partialResults: import("@empathyco/x-types").PartialResult[];
+    promoteds: import("@empathyco/x-types").Promoted[];
+    queryTagging: import("@empathyco/x-types").TaggingRequest;
+    redirections: import("@empathyco/x-types").Redirection[];
+    results: import("@empathyco/x-types").Result[];
+    spellcheck: string;
+    totalResults: number;
+}>
+```

package/docs/API-reference/api/x-adapter-platform.searchresponsemutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [searchResponseMutableSchema](./x-adapter-platform.searchresponsemutableschema.md)
+
+## searchResponseMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+searchResponseMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformSearchResponse, SearchResponse>>
+```

package/docs/API-reference/api/x-adapter-platform.simplefiltermutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [simpleFilterMutableSchema](./x-adapter-platform.simplefiltermutableschema.md)
+
+## simpleFilterMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+simpleFilterMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformFilter, SimpleFilter>>
+```

package/docs/API-reference/api/x-adapter-platform.suggestionmutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [suggestionMutableSchema](./x-adapter-platform.suggestionmutableschema.md)
+
+## suggestionMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+suggestionMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<PlatformSuggestion, Suggestion>>
+```

package/docs/API-reference/api/x-adapter-platform.taggingendpointadapter.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [taggingEndpointAdapter](./x-adapter-platform.taggingendpointadapter.md)
+
+## taggingEndpointAdapter variable
+
+<b>Signature:</b>
+
+```typescript
+taggingEndpointAdapter: import("@empathyco/x-adapter-next").ExtendableEndpointAdapter<TaggingRequest, void>
+```

package/docs/API-reference/api/x-adapter-platform.taggingrequestmapper.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [taggingRequestMapper](./x-adapter-platform.taggingrequestmapper.md)
+
+## taggingRequestMapper variable
+
+<b>Signature:</b>
+
+```typescript
+taggingRequestMapper: import("@empathyco/x-adapter-next").Mapper<TaggingRequest, any>
+```

package/docs/API-reference/api/x-adapter-platform.taggingrequestmutableschema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [taggingRequestMutableSchema](./x-adapter-platform.taggingrequestmutableschema.md)
+
+## taggingRequestMutableSchema variable
+
+<b>Signature:</b>
+
+```typescript
+taggingRequestMutableSchema: import("@empathyco/x-adapter-next").MutableSchema<Schema<TaggingRequest, any>>
+```

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

@@ -11,7 +11,7 @@ Class implementation for the [HistoryQueriesActions.addQueryToHistory()](./x-com
 ```typescript
 export declare class AddQueryToHistoryAction implements ActionsClass<HistoryQueriesXStoreModule> 
 ```
-<b>Implements:</b> [ActionsClass](./x-components.actionsclass.md)<!-- -->&lt;[HistoryQueriesXStoreModule](./x-components.historyqueriesxstoremodule.md)<!-- -->&gt;
+<b>Implements:</b> [ActionsClass](./x-components.actionsclass.md)<!-- -->&lt;[HistoryQueriesXStoreModule](./x-components.historyqueriesxstoremodule.md)
 
 ## Methods
 

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.historyqueriesgetter.md

@@ -11,7 +11,7 @@ Class implementation for the [HistoryQueriesGetters.historyQueries](./x-componen
 ```typescript
 export declare class HistoryQueriesGetter implements GettersClass<HistoryQueriesXStoreModule> 
 ```
-<b>Implements:</b> [GettersClass](./x-components.gettersclass.md)<!-- -->&lt;[HistoryQueriesXStoreModule](./x-components.historyqueriesxstoremodule.md)<!-- -->&gt;
+<b>Implements:</b> [GettersClass](./x-components.gettersclass.md)<!-- -->&lt;[HistoryQueriesXStoreModule](./x-components.historyqueriesxstoremodule.md)
 
 ## Methods
 

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.identifierresultsrequestchanged.md

@@ -9,5 +9,5 @@ Any property of the identifier results request has changed. Payload: The new [id
 <b>Signature:</b>
 
 ```typescript
-IdentifierResultsRequestChanged: SearchByIdRequest | null;
+IdentifierResultsRequestChanged: IdentifierResultsRequest | null;
 ```

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

@@ -17,6 +17,6 @@ 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-types.identifierresultsrequest.md) or <code>null</code> if there is not enough data in the state nto conform a valid request. |
+|  [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.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

@@ -17,6 +17,6 @@ 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. |
+|  [PopularSearchesRequestChanged](./x-components.popularsearchesxevents.popularsearchesrequestchanged.md) | PopularSearchesRequest | Any property of the popular-searches request has changed Payload: The new [popular-search request](./x-types.popularsearchesrequest.md)<!-- -->. |
 |  [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.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](./x-types.popularsearchesrequest.md)<!-- -->.
 
 <b>Signature:</b>
 
 ```typescript
-PopularSearchesRequestChanged: SuggestionsRequest;
+PopularSearchesRequestChanged: PopularSearchesRequest;
 ```

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

@@ -16,6 +16,6 @@ export interface PrivateXModuleOptions<Module extends AnyXModule>
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [storeEmitters?](./x-components.privatexmoduleoptions.storeemitters.md) | Partial&lt;[StoreEmitters](./x-components.storeemitters.md)<!-- -->&lt;Module\['storeModule'\]&gt;&gt; | <i>(Optional)</i> The options to override events that will be emitted when a the getters value or the state of the store changes. |
+|  [storeEmitters?](./x-components.privatexmoduleoptions.storeemitters.md) | Partial&lt;[StoreEmitters](./x-components.storeemitters.md)<!-- -->&lt;Module\['storeModule'\]&gt;&gt; | <i>(Optional)</i> The options to override events that will be emitted when the getters value or the state of the store changes. |
 |  [storeModule?](./x-components.privatexmoduleoptions.storemodule.md) | [XStoreModuleOptions](./x-components.xstoremoduleoptions.md)<!-- -->&lt;Module\['storeModule'\]&gt; | <i>(Optional)</i> The options to override the default store module configuration. |
 

package/docs/API-reference/api/x-components.privatexmoduleoptions.storeemitters.md

@@ -4,7 +4,7 @@
 
 ## PrivateXModuleOptions.storeEmitters property
 
-The options to override events that will be emitted when a the getters value or the state of the store changes.
+The options to override events that will be emitted when the getters value or the state of the store changes.
 
 <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.querysuggestionsgetter.md

@@ -11,7 +11,7 @@ Class implementation for the [QuerySuggestionsGetter.querySuggestions()](./x-com
 ```typescript
 export declare class QuerySuggestionsGetter implements GettersClass<QuerySuggestionsXStoreModule> 
 ```
-<b>Implements:</b> [GettersClass](./x-components.gettersclass.md)<!-- -->&lt;[QuerySuggestionsXStoreModule](./x-components.querysuggestionsxstoremodule.md)<!-- -->&gt;
+<b>Implements:</b> [GettersClass](./x-components.gettersclass.md)<!-- -->&lt;[QuerySuggestionsXStoreModule](./x-components.querysuggestionsxstoremodule.md)
 
 ## Methods
 

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

@@ -18,6 +18,6 @@ export interface QuerySuggestionsXEvents
 |  --- | --- | --- |
 |  [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. |
+|  [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.querysuggestionsrequestchanged.md

@@ -9,5 +9,5 @@ Any property of the query-suggestions request has changed. Payload: The new quer
 <b>Signature:</b>
 
 ```typescript
-QuerySuggestionsRequestChanged: SuggestionsRequest | null;
+QuerySuggestionsRequestChanged: QuerySuggestionsRequest | null;
 ```