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

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 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.97](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.96...@empathyco/x-components@3.0.0-alpha.97) (2022-05-13)
+
+### Features
+
+- move `response` types to `@empathyco/x-types`
+  ([77fb812](https://github.com/empathyco/x/commit/77fb812b77fe0c84462a4b5b2eb7f0439e2d8061)),
+  closes [EX-6092](https://searchbroker.atlassian.net/browse/EX-6092)
+
+# 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.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

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

@@ -4,7 +4,7 @@
 
 ## InternalSearchRequest interface
 
-An internal search request containing the page used to calculate the start and rows properties of a [SearchRequest](./x-adapter.searchrequest.md)<!-- -->.
+An internal search request containing the page used to calculate the start and rows properties of a [SearchRequest](./x-types.searchrequest.md)<!-- -->.
 
 <b>Signature:</b>
 

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

@@ -246,7 +246,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [InfiniteScroll](./x-components.infinitescroll.md) | Interface to be implemented by the component which uses the infinite scroll directive. If the component wants to trigger an action when the scroll is about to end it needs to implement the <code>onInfiniteScrollEnd</code> method. |
 |  [InitWrapper](./x-components.initwrapper.md) | Interface for the returned type of the [XInstaller.init()](./x-components.xinstaller.init.md) function. |
 |  [InstallXOptions](./x-components.installxoptions.md) | Interface for the parameter of the constructor of [XInstaller](./x-components.xinstaller.md) function. It is an extended version of [XPluginOptions](./x-components.xpluginoptions.md)<!-- -->. |
-|  [InternalSearchRequest](./x-components.internalsearchrequest.md) | An internal search request containing the page used to calculate the start and rows properties of a [SearchRequest](./x-adapter.searchrequest.md)<!-- -->. |
+|  [InternalSearchRequest](./x-components.internalsearchrequest.md) | An internal search request containing the page used to calculate the start and rows properties of a [SearchRequest](./x-types.searchrequest.md)<!-- -->. |
 |  [NamespacedWireCommit](./x-components.namespacedwirecommit.md) | Namespaced type for the [wireCommit()](./x-components.wirecommit.md) which creates a wire with its payload associated. Possible ways for creating a wire that commits a mutation. If a payload is passed, then the observable payload can be ignored, so the wire is applicable to any event. If no payload is passed, then the wire is only applicable to events with the same payload type than the mutation. |
 |  [NamespacedWireDispatch](./x-components.namespacedwiredispatch.md) | Namespaced type for the [wireDispatch()](./x-components.wiredispatch.md) which creates a wire with its payload associated. Possible ways for creating a wire that dispatches an action. If a payload is passed, then the observable payload can be ignored, so the wire is applicable to any event. If no payload is passed, then the wire is only applicable to events with the same payload type than the action. |
 |  [NextQueriesActions](./x-components.nextqueriesactions.md) | Next queries module actions. |

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

@@ -22,6 +22,6 @@ export interface SearchActions
 |  [increasePageAppendingResults()](./x-components.searchactions.increasepageappendingresults.md) | Checks if there are more pages of results to load. If there are, then increases the page number in state and set to <code>true</code> the [SearchState.isAppendResults](./x-components.searchstate.isappendresults.md) flag. |
 |  [resetState(watchedRequest)](./x-components.searchactions.resetstate.md) | Batches state resets in a single action after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update. |
 |  [saveOrigin(originInit)](./x-components.searchactions.saveorigin.md) | Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it. |
-|  [saveSearchResponse(response)](./x-components.searchactions.savesearchresponse.md) | Saves the [SearchResponse](./x-adapter.searchresponse.md)<!-- -->. |
+|  [saveSearchResponse(response)](./x-components.searchactions.savesearchresponse.md) | Saves the [SearchResponse](./x-types.searchresponse.md)<!-- -->. |
 |  [setUrlParams(urlParams)](./x-components.searchactions.seturlparams.md) | Checks if the url has params on it and then updates the state with these values. |
 

package/docs/API-reference/api/x-components.searchactions.savesearchresponse.md

@@ -4,7 +4,7 @@
 
 ## SearchActions.saveSearchResponse() method
 
-Saves the [SearchResponse](./x-adapter.searchresponse.md)<!-- -->.
+Saves the [SearchResponse](./x-types.searchresponse.md)<!-- -->.
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ saveSearchResponse(response: SearchResponse): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  response | SearchResponse | The [SearchResponse](./x-adapter.searchresponse.md) to save. |
+|  response | SearchResponse | The [SearchResponse](./x-types.searchresponse.md) to save. |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-types.identifierresultsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [IdentifierResultsResponse](./x-types.identifierresultsresponse.md)
+
+## IdentifierResultsResponse interface
+
+Response for the identifier results endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface IdentifierResultsResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [results](./x-types.identifierresultsresponse.results.md) | [Result](./x-types.result.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.identifierresultsresponse.results.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [IdentifierResultsResponse](./x-types.identifierresultsresponse.md) &gt; [results](./x-types.identifierresultsresponse.results.md)
+
+## IdentifierResultsResponse.results property
+
+<b>Signature:</b>
+
+```typescript
+results: Result[];
+```

package/docs/API-reference/api/x-types.md

@@ -44,30 +44,37 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [HistoryQuery](./x-types.historyquery.md) | Represents a query that has been made by the user. |
 |  [Identifiable](./x-types.identifiable.md) | Represents an Object with id property. |
 |  [IdentifierResultsRequest](./x-types.identifierresultsrequest.md) | Request for Identifier Results endpoint. |
+|  [IdentifierResultsResponse](./x-types.identifierresultsresponse.md) | Response for the identifier results endpoint. |
 |  [NamedModel](./x-types.namedmodel.md) | Common interface to ease the differentiate between different model types. |
 |  [NextQueries](./x-types.nextqueries.md) | A group of next queries. |
 |  [NextQueriesRequest](./x-types.nextqueriesrequest.md) | Request for Next Queries endpoint. |
+|  [NextQueriesResponse](./x-types.nextqueriesresponse.md) | Response for the next queries endpoint. |
 |  [NextQuery](./x-types.nextquery.md) | A next query is a suggestion of a new query that the user may be interested after searching for an specific term. |
 |  [NumberRangeFacet](./x-types.numberrangefacet.md) | Number Range Facet is a trait for filtering results. It extends from [Facet](./x-types.facet.md)<!-- -->, changes the modelName and uses [NumberRangeFilter](./x-types.numberrangefilter.md) as filters. |
 |  [NumberRangeFilter](./x-types.numberrangefilter.md) | A type of filter used in [NumberRangeFacet](./x-types.numberrangefacet.md) and extends from [BooleanFilter](./x-types.booleanfilter.md)<!-- -->. This filter has the particularity that its range property is an object with a range of numbers. The difference with [EditableNumberRangeFilter](./x-types.editablenumberrangefilter.md) is that range's values are not editable. There are different NumberRangeFilters within the facet to cover different predefined range options. |
 |  [PageableRequest](./x-types.pageablerequest.md) | Interface for any Request which supports pagination. |
 |  [PartialResult](./x-types.partialresult.md) | A partial result represents a sub-query of a user search term which normally has not enough results (or not results at all). It includes a preview of these results and the number of total results that match against the sub-query. |
 |  [PopularSearchesRequest](./x-types.popularsearchesrequest.md) | Request for Popular Searches endpoint. |
+|  [PopularSearchesResponse](./x-types.popularsearchesresponse.md) | Response for the popular searches endpoint. |
 |  [Previewable](./x-types.previewable.md) | Represents an item that is searchable, and the results associated to it. |
 |  [Promoted](./x-types.promoted.md) | A promoted is an image with a title, that when clicked redirect the user to an URL. Often it is represented taking up the same space than a normal result. |
 |  [QueryableRequest](./x-types.queryablerequest.md) | Interface for any Request with a <code>query</code> parameter. |
 |  [QuerySuggestionsRequest](./x-types.querysuggestionsrequest.md) | Request for Query Suggestions endpoint. |
+|  [QuerySuggestionsResponse](./x-types.querysuggestionsresponse.md) | Response for the query suggestions endpoint. |
 |  [RangeValue](./x-types.rangevalue.md) | A numeric range filter value. |
 |  [RawFilter](./x-types.rawfilter.md) | A filter which id is the value of the filter. It can be selected or not. |
 |  [RecommendationsRequest](./x-types.recommendationsrequest.md) | Request for Recommendations endpoint. |
+|  [RecommendationsResponse](./x-types.recommendationsresponse.md) | Response for the recommendations endpoint. |
 |  [Redirection](./x-types.redirection.md) | A redirection (AKA Direct Link) is simply a URL. Normally, the user is just redirected to it after making a query that matches the configuration of this URL. In other cases it is shown as a button that the user can click, and which will trigger the redirect action. |
 |  [RelatedTag](./x-types.relatedtag.md) | A related tag is just a term that refines the current query. |
 |  [RelatedTagsRequest](./x-types.relatedtagsrequest.md) | Request for Related Tags endpoint. |
+|  [RelatedTagsResponse](./x-types.relatedtagsresponse.md) | Response for the related tags endpoint. |
 |  [Result](./x-types.result.md) | A search result. |
 |  [ResultIdentifier](./x-types.resultidentifier.md) | The client result identifier (SKU, MOCACO, a simple ID...). |
 |  [ResultPrice](./x-types.resultprice.md) | The result price. |
 |  [ResultRating](./x-types.resultrating.md) | The result rating. |
 |  [SearchRequest](./x-types.searchrequest.md) | The Request for the Search endpoint. |
+|  [SearchResponse](./x-types.searchresponse.md) | Response for the search endpoint. |
 |  [SimpleFacet](./x-types.simplefacet.md) | Simple facet is a trait for filtering results. It extends from [Facet](./x-types.facet.md)<!-- -->, changes the modelName and uses [SimpleFilter](./x-types.simplefilter.md) as filters. |
 |  [SimpleFilter](./x-types.simplefilter.md) | A type of filter used in [SimpleFacet](./x-types.simplefacet.md) and extends from [Filter](./x-types.filter.md)<!-- -->. It can be selected or not. |
 |  [SortableRequest](./x-types.sortablerequest.md) | Interface for any Request with sorting. |
@@ -76,6 +83,7 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [Tagging](./x-types.tagging.md) | The tagging user actions. |
 |  [TaggingRequest](./x-types.taggingrequest.md) | The request for the tagging API. |
 |  [TrackableRequest](./x-types.trackablerequest.md) | Interface for any Request with tagging. |
+|  [TrackableShowResponse](./x-types.trackableshowresponse.md) | Response to be implemented by all responses that contain a part to track the show event. |
 |  [UserInfo](./x-types.userinfo.md) | The representation of the user. |
 
 ## Variables

package/docs/API-reference/api/x-types.nextqueriesresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [NextQueriesResponse](./x-types.nextqueriesresponse.md)
+
+## NextQueriesResponse interface
+
+Response for the next queries endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface NextQueriesResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [nextQueries](./x-types.nextqueriesresponse.nextqueries.md) | [NextQuery](./x-types.nextquery.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.nextqueriesresponse.nextqueries.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [NextQueriesResponse](./x-types.nextqueriesresponse.md) &gt; [nextQueries](./x-types.nextqueriesresponse.nextqueries.md)
+
+## NextQueriesResponse.nextQueries property
+
+<b>Signature:</b>
+
+```typescript
+nextQueries: NextQuery[];
+```

package/docs/API-reference/api/x-types.popularsearchesresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [PopularSearchesResponse](./x-types.popularsearchesresponse.md)
+
+## PopularSearchesResponse interface
+
+Response for the popular searches endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface PopularSearchesResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [suggestions](./x-types.popularsearchesresponse.suggestions.md) | [Suggestion](./x-types.suggestion.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.popularsearchesresponse.suggestions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [PopularSearchesResponse](./x-types.popularsearchesresponse.md) &gt; [suggestions](./x-types.popularsearchesresponse.suggestions.md)
+
+## PopularSearchesResponse.suggestions property
+
+<b>Signature:</b>
+
+```typescript
+suggestions: Suggestion[];
+```

package/docs/API-reference/api/x-types.querysuggestionsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [QuerySuggestionsResponse](./x-types.querysuggestionsresponse.md)
+
+## QuerySuggestionsResponse interface
+
+Response for the query suggestions endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface QuerySuggestionsResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [suggestions](./x-types.querysuggestionsresponse.suggestions.md) | [Suggestion](./x-types.suggestion.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.querysuggestionsresponse.suggestions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [QuerySuggestionsResponse](./x-types.querysuggestionsresponse.md) &gt; [suggestions](./x-types.querysuggestionsresponse.suggestions.md)
+
+## QuerySuggestionsResponse.suggestions property
+
+<b>Signature:</b>
+
+```typescript
+suggestions: Suggestion[];
+```

package/docs/API-reference/api/x-types.recommendationsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RecommendationsResponse](./x-types.recommendationsresponse.md)
+
+## RecommendationsResponse interface
+
+Response for the recommendations endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface RecommendationsResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [results](./x-types.recommendationsresponse.results.md) | [Result](./x-types.result.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.recommendationsresponse.results.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RecommendationsResponse](./x-types.recommendationsresponse.md) &gt; [results](./x-types.recommendationsresponse.results.md)
+
+## RecommendationsResponse.results property
+
+<b>Signature:</b>
+
+```typescript
+results: Result[];
+```

package/docs/API-reference/api/x-types.relatedtagsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedTagsResponse](./x-types.relatedtagsresponse.md)
+
+## RelatedTagsResponse interface
+
+Response for the related tags endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface RelatedTagsResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [relatedTags](./x-types.relatedtagsresponse.relatedtags.md) | [RelatedTag](./x-types.relatedtag.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.relatedtagsresponse.relatedtags.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedTagsResponse](./x-types.relatedtagsresponse.md) &gt; [relatedTags](./x-types.relatedtagsresponse.relatedtags.md)
+
+## RelatedTagsResponse.relatedTags property
+
+<b>Signature:</b>
+
+```typescript
+relatedTags: RelatedTag[];
+```

package/docs/API-reference/api/x-types.searchresponse.banners.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [banners](./x-types.searchresponse.banners.md)
+
+## SearchResponse.banners property
+
+<b>Signature:</b>
+
+```typescript
+banners?: Banner[];
+```

package/docs/API-reference/api/x-types.searchresponse.facets.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [facets](./x-types.searchresponse.facets.md)
+
+## SearchResponse.facets property
+
+<b>Signature:</b>
+
+```typescript
+facets?: Facet[];
+```

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md)
+
+## SearchResponse interface
+
+Response for the search endpoint.
+
+<b>Signature:</b>
+
+```typescript
+export interface SearchResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [banners?](./x-types.searchresponse.banners.md) | [Banner](./x-types.banner.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  [facets?](./x-types.searchresponse.facets.md) | [Facet](./x-types.facet.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  [partialResults?](./x-types.searchresponse.partialresults.md) | [PartialResult](./x-types.partialresult.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  [promoteds?](./x-types.searchresponse.promoteds.md) | [Promoted](./x-types.promoted.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  [queryTagging](./x-types.searchresponse.querytagging.md) | [TaggingRequest](./x-types.taggingrequest.md) |  |
+|  [redirections?](./x-types.searchresponse.redirections.md) | [Redirection](./x-types.redirection.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  [results](./x-types.searchresponse.results.md) | [Result](./x-types.result.md)<!-- -->\[\] |  |
+|  [spellcheck?](./x-types.searchresponse.spellcheck.md) | string | <i>(Optional)</i> |
+|  [totalResults](./x-types.searchresponse.totalresults.md) | number |  |
+

package/docs/API-reference/api/x-types.searchresponse.partialresults.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [partialResults](./x-types.searchresponse.partialresults.md)
+
+## SearchResponse.partialResults property
+
+<b>Signature:</b>
+
+```typescript
+partialResults?: PartialResult[];
+```

package/docs/API-reference/api/x-types.searchresponse.promoteds.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [promoteds](./x-types.searchresponse.promoteds.md)
+
+## SearchResponse.promoteds property
+
+<b>Signature:</b>
+
+```typescript
+promoteds?: Promoted[];
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [queryTagging](./x-types.searchresponse.querytagging.md)
+
+## SearchResponse.queryTagging property
+
+<b>Signature:</b>
+
+```typescript
+queryTagging: TaggingRequest;
+```

package/docs/API-reference/api/x-types.searchresponse.redirections.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [redirections](./x-types.searchresponse.redirections.md)
+
+## SearchResponse.redirections property
+
+<b>Signature:</b>
+
+```typescript
+redirections?: Redirection[];
+```

package/docs/API-reference/api/x-types.searchresponse.results.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [results](./x-types.searchresponse.results.md)
+
+## SearchResponse.results property
+
+<b>Signature:</b>
+
+```typescript
+results: Result[];
+```

package/docs/API-reference/api/x-types.searchresponse.spellcheck.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [spellcheck](./x-types.searchresponse.spellcheck.md)
+
+## SearchResponse.spellcheck property
+
+<b>Signature:</b>
+
+```typescript
+spellcheck?: string;
+```

package/docs/API-reference/api/x-types.searchresponse.totalresults.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [SearchResponse](./x-types.searchresponse.md) &gt; [totalResults](./x-types.searchresponse.totalresults.md)
+
+## SearchResponse.totalResults property
+
+<b>Signature:</b>
+
+```typescript
+totalResults: number;
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [TrackableShowResponse](./x-types.trackableshowresponse.md)
+
+## TrackableShowResponse interface
+
+Response to be implemented by all responses that contain a part to track the show event.
+
+<b>Signature:</b>
+
+```typescript
+export interface TrackableShowResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [showTagging](./x-types.trackableshowresponse.showtagging.md) | [TaggingRequest](./x-types.taggingrequest.md) |  |
+

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [TrackableShowResponse](./x-types.trackableshowresponse.md) &gt; [showTagging](./x-types.trackableshowresponse.showtagging.md)
+
+## TrackableShowResponse.showTagging property
+
+<b>Signature:</b>
+
+```typescript
+showTagging: TaggingRequest;
+```

package/js/x-modules/search/store/actions/fetch-and-save-search-response.action.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetch-and-save-search-response.action.js","sources":["../../../../../../src/x-modules/search/store/actions/fetch-and-save-search-response.action.ts"],"sourcesContent":["import { SearchResponse } from '@empathyco/x-adapter';\nimport { SearchRequest } from '@empathyco/x-types';\nimport { createFetchAndSaveActions } from '../../../../store/utils/fetch-and-save-action.utils';\nimport { InternalSearchRequest } from '../../types';\nimport { SearchActionContext, SearchState } from '../types';\n\nconst { fetchAndSave, cancelPrevious } = createFetchAndSaveActions<\n  SearchActionContext,\n  InternalSearchRequest | null,\n  SearchResponse\n>({\n  fetch({ dispatch, state }, request) {\n    return dispatch('fetchSearchResponse', request ? enrichRequest(request, state) : null);\n  },\n  onSuccess({ dispatch }, response) {\n    dispatch('saveSearchResponse', response);\n  }\n});\n\n/**\n * Enriches the {@link SearchRequest} object with the origin and page properties taken from the\n * {@link SearchState | search state}.\n *\n * @param request - The {@link InternalSearchRequest}.\n * @param state - {@link SearchState}.\n *\n * @returns The search request.\n * @internal\n */\nfunction enrichRequest(request: InternalSearchRequest, state: SearchState): SearchRequest {\n  const { page, ...restRequest } = request;\n  const {\n    config: { pageSize },\n    origin,\n    results\n  } = state;\n  const start = page === 1 ? 0 : results.length;\n\n  return {\n    ...restRequest,\n    // eslint-disable-next-line @typescript-eslint/no-extra-parens\n    ...(origin && { origin }),\n    start,\n    rows: pageSize * page - start\n  };\n}\n\n/**\n * Default implementation for {@link SearchActions.fetchAndSaveSearchResponse} action.\n *\n * @public\n */\nexport const fetchAndSaveSearchResponse = fetchAndSave;\n\n/**\n * Default implementation for {@link SearchActions.cancelFetchAndSaveSearchResponse} action.\n *\n * @public\n */\nexport const cancelFetchAndSaveSearchResponse = cancelPrevious;\n"],"names":[],"mappings":";;AAMA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,yBAAyB,CAIhE;IACA,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,OAAO;QAChC,OAAO,QAAQ,CAAC,qBAAqB,EAAE,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;KACxF;IACD,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE,QAAQ;QAC9B,QAAQ,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;KAC1C;CACF,CAAC,CAAC;AAEH;;;;;;;;;;AAUA,SAAS,aAAa,CAAC,OAA8B,EAAE,KAAkB;IACvE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,EACJ,MAAM,EAAE,EAAE,QAAQ,EAAE,EACpB,MAAM,EACN,OAAO,EACR,GAAG,KAAK,CAAC;IACV,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAE9C,OAAO;QACL,GAAG,WAAW;;QAEd,IAAI,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QACzB,KAAK;QACL,IAAI,EAAE,QAAQ,GAAG,IAAI,GAAG,KAAK;KAC9B,CAAC;AACJ,CAAC;AAED;;;;;MAKa,0BAA0B,GAAG,aAAa;AAEvD;;;;;MAKa,gCAAgC,GAAG;;;;"}
+{"version":3,"file":"fetch-and-save-search-response.action.js","sources":["../../../../../../src/x-modules/search/store/actions/fetch-and-save-search-response.action.ts"],"sourcesContent":["import { SearchRequest, SearchResponse } from '@empathyco/x-types';\nimport { createFetchAndSaveActions } from '../../../../store/utils/fetch-and-save-action.utils';\nimport { InternalSearchRequest } from '../../types';\nimport { SearchActionContext, SearchState } from '../types';\n\nconst { fetchAndSave, cancelPrevious } = createFetchAndSaveActions<\n  SearchActionContext,\n  InternalSearchRequest | null,\n  SearchResponse\n>({\n  fetch({ dispatch, state }, request) {\n    return dispatch('fetchSearchResponse', request ? enrichRequest(request, state) : null);\n  },\n  onSuccess({ dispatch }, response) {\n    dispatch('saveSearchResponse', response);\n  }\n});\n\n/**\n * Enriches the {@link SearchRequest} object with the origin and page properties taken from the\n * {@link SearchState | search state}.\n *\n * @param request - The {@link InternalSearchRequest}.\n * @param state - {@link SearchState}.\n *\n * @returns The search request.\n * @internal\n */\nfunction enrichRequest(request: InternalSearchRequest, state: SearchState): SearchRequest {\n  const { page, ...restRequest } = request;\n  const {\n    config: { pageSize },\n    origin,\n    results\n  } = state;\n  const start = page === 1 ? 0 : results.length;\n\n  return {\n    ...restRequest,\n    // eslint-disable-next-line @typescript-eslint/no-extra-parens\n    ...(origin && { origin }),\n    start,\n    rows: pageSize * page - start\n  };\n}\n\n/**\n * Default implementation for {@link SearchActions.fetchAndSaveSearchResponse} action.\n *\n * @public\n */\nexport const fetchAndSaveSearchResponse = fetchAndSave;\n\n/**\n * Default implementation for {@link SearchActions.cancelFetchAndSaveSearchResponse} action.\n *\n * @public\n */\nexport const cancelFetchAndSaveSearchResponse = cancelPrevious;\n"],"names":[],"mappings":";;AAKA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,yBAAyB,CAIhE;IACA,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,OAAO;QAChC,OAAO,QAAQ,CAAC,qBAAqB,EAAE,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;KACxF;IACD,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE,QAAQ;QAC9B,QAAQ,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;KAC1C;CACF,CAAC,CAAC;AAEH;;;;;;;;;;AAUA,SAAS,aAAa,CAAC,OAA8B,EAAE,KAAkB;IACvE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,EACJ,MAAM,EAAE,EAAE,QAAQ,EAAE,EACpB,MAAM,EACN,OAAO,EACR,GAAG,KAAK,CAAC;IACV,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAE9C,OAAO;QACL,GAAG,WAAW;;QAEd,IAAI,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QACzB,KAAK;QACL,IAAI,EAAE,QAAQ,GAAG,IAAI,GAAG,KAAK;KAC9B,CAAC;AACJ,CAAC;AAED;;;;;MAKa,0BAA0B,GAAG,aAAa;AAEvD;;;;;MAKa,gCAAgC,GAAG;;;;"}

package/js/x-modules/search/store/actions/save-search-response.action.js

@@ -3,7 +3,7 @@
  *
  * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
  * provided by Vuex.
- * @param response - The {@link @empathyco/x-adapter#SearchResponse} to save.
+ * @param response - The {@link @empathyco/x-types#SearchResponse} to save.
  *
  * @public
  */

package/js/x-modules/search/store/actions/save-search-response.action.js.map

@@ -1 +1 @@
-{"version":3,"file":"save-search-response.action.js","sources":["../../../../../../src/x-modules/search/store/actions/save-search-response.action.ts"],"sourcesContent":["import { SearchXStoreModule } from '../types';\n\n/**\n * Default implementation for the {@link SearchActions.saveSearchResponse}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n * @param response - The {@link @empathyco/x-adapter#SearchResponse} to save.\n *\n * @public\n */\nexport const saveSearchResponse: SearchXStoreModule['actions']['saveSearchResponse'] = (\n  { commit, state },\n  {\n    results,\n    partialResults,\n    facets,\n    banners,\n    promoteds,\n    totalResults,\n    spellcheck,\n    redirections,\n    queryTagging\n  }\n) => {\n  if (state.isAppendResults) {\n    commit('appendResults', results);\n  } else {\n    commit('setResults', results);\n    commit('setBanners', banners ?? []);\n    commit('setPromoteds', promoteds ?? []);\n    commit('setRedirections', redirections ?? []);\n  }\n\n  commit('setPartialResults', partialResults ?? []);\n\n  if (facets) {\n    commit('setFacets', facets);\n  }\n\n  if (queryTagging) {\n    commit('setQueryTagging', queryTagging);\n  }\n  commit('setTotalResults', totalResults);\n  commit('setSpellcheck', spellcheck ?? '');\n};\n"],"names":[],"mappings":"AAEA;;;;;;;;;MASa,kBAAkB,GAAwD,CACrF,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,EACE,OAAO,EACP,cAAc,EACd,MAAM,EACN,OAAO,EACP,SAAS,EACT,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,YAAY,EACb;IAED,IAAI,KAAK,CAAC,eAAe,EAAE;QACzB,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;KAClC;SAAM;QACL,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC9B,MAAM,CAAC,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QACpC,MAAM,CAAC,cAAc,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,iBAAiB,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC;KAC/C;IAED,MAAM,CAAC,mBAAmB,EAAE,cAAc,IAAI,EAAE,CAAC,CAAC;IAElD,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;KAC7B;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;KACzC;IACD,MAAM,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IACxC,MAAM,CAAC,eAAe,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC;AAC5C;;;;"}
+{"version":3,"file":"save-search-response.action.js","sources":["../../../../../../src/x-modules/search/store/actions/save-search-response.action.ts"],"sourcesContent":["import { SearchXStoreModule } from '../types';\n\n/**\n * Default implementation for the {@link SearchActions.saveSearchResponse}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n * @param response - The {@link @empathyco/x-types#SearchResponse} to save.\n *\n * @public\n */\nexport const saveSearchResponse: SearchXStoreModule['actions']['saveSearchResponse'] = (\n  { commit, state },\n  {\n    results,\n    partialResults,\n    facets,\n    banners,\n    promoteds,\n    totalResults,\n    spellcheck,\n    redirections,\n    queryTagging\n  }\n) => {\n  if (state.isAppendResults) {\n    commit('appendResults', results);\n  } else {\n    commit('setResults', results);\n    commit('setBanners', banners ?? []);\n    commit('setPromoteds', promoteds ?? []);\n    commit('setRedirections', redirections ?? []);\n  }\n\n  commit('setPartialResults', partialResults ?? []);\n\n  if (facets) {\n    commit('setFacets', facets);\n  }\n\n  if (queryTagging) {\n    commit('setQueryTagging', queryTagging);\n  }\n  commit('setTotalResults', totalResults);\n  commit('setSpellcheck', spellcheck ?? '');\n};\n"],"names":[],"mappings":"AAEA;;;;;;;;;MASa,kBAAkB,GAAwD,CACrF,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,EACE,OAAO,EACP,cAAc,EACd,MAAM,EACN,OAAO,EACP,SAAS,EACT,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,YAAY,EACb;IAED,IAAI,KAAK,CAAC,eAAe,EAAE;QACzB,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;KAClC;SAAM;QACL,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC9B,MAAM,CAAC,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QACpC,MAAM,CAAC,cAAc,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,iBAAiB,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC;KAC/C;IAED,MAAM,CAAC,mBAAmB,EAAE,cAAc,IAAI,EAAE,CAAC,CAAC;IAElD,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;KAC7B;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;KACzC;IACD,MAAM,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IACxC,MAAM,CAAC,eAAe,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC;AAC5C;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.96",
+  "version": "3.0.0-alpha.97",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -59,12 +59,12 @@
     "cypress:open:component": "cypress open-ct"
   },
   "dependencies": {
-    "@empathyco/x-adapter": "^7.0.0-alpha.29",
-    "@empathyco/x-deep-merge": "^1.3.0-alpha.14",
+    "@empathyco/x-adapter": "^7.0.0-alpha.30",
+    "@empathyco/x-deep-merge": "^1.3.0-alpha.15",
     "@empathyco/x-logger": "^1.2.0-alpha.3",
     "@empathyco/x-storage-service": "^2.0.0-alpha.2",
-    "@empathyco/x-types": "^10.0.0-alpha.22",
-    "@empathyco/x-utils": "^1.0.0-alpha.0",
+    "@empathyco/x-types": "^10.0.0-alpha.23",
+    "@empathyco/x-utils": "^1.0.0-alpha.1",
     "@types/resize-observer-browser": "~0.1.5",
     "reflect-metadata": "~0.1.13",
     "rxjs": "~7.4.0",
@@ -125,5 +125,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "493d82efa77d1c84e7806e6ad8b47cbe99d663d4"
+  "gitHead": "bba3b1ec059a5f45e743ae51aa49d8de5e4ec271"
 }

package/report/x-components.api.json

@@ -22118,7 +22118,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-components!InternalSearchRequest:interface",
-          "docComment": "/**\n * An internal search request containing the page used to calculate the start and rows properties of a {@link @empathyco/x-adapter#SearchRequest}.\n *\n * @public\n */\n",
+          "docComment": "/**\n * An internal search request containing the page used to calculate the start and rows properties of a {@link @empathyco/x-types#SearchRequest}.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -34362,7 +34362,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!saveSearchResponse:var",
-          "docComment": "/**\n * Default implementation for the {@link SearchActions.saveSearchResponse}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param response - The {@link @empathyco/x-adapter#SearchResponse} to save.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Default implementation for the {@link SearchActions.saveSearchResponse}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param response - The {@link @empathyco/x-types#SearchResponse} to save.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -36001,7 +36001,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@empathyco/x-components!SearchActions#saveSearchResponse:member(1)",
-              "docComment": "/**\n * Saves the {@link @empathyco/x-adapter#SearchResponse}.\n *\n * @param response - The {@link @empathyco/x-adapter#SearchResponse} to save.\n */\n",
+              "docComment": "/**\n * Saves the {@link @empathyco/x-types#SearchResponse}.\n *\n * @param response - The {@link @empathyco/x-types#SearchResponse} to save.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",