@empathyco/x-components 3.0.0-alpha.163 → 3.0.0-alpha.166

package/CHANGELOG.md

@@ -3,6 +3,45 @@
 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.166](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.165...@empathyco/x-components@3.0.0-alpha.166) (2022-09-02)
+
+### Bug Fixes
+
+- Make `Home` grid next queries use grid data rather than state data. (#687)
+  ([e340ed0](https://github.com/empathyco/x/commit/e340ed0c4fc4d70a0912c38296812c2fcc0c4e23)),
+  closes [EX-6955](https://searchbroker.atlassian.net/browse/EX-6955)
+
+# 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.165](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.164...@empathyco/x-components@3.0.0-alpha.165) (2022-08-31)
+
+### Build System
+
+- **dependencies:** fix Vue & Vuex versions (#686)
+  ([177e851](https://github.com/empathyco/x/commit/177e8511f4458fa13c627210cdfbbf6d42a85b17)),
+  closes [EX-6918](https://searchbroker.atlassian.net/browse/EX-6918)
+
+# 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.164](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.163...@empathyco/x-components@3.0.0-alpha.164) (2022-08-30)
+
+### Features
+
+- **queries-preview:** add wiring and actions (#677)
+  ([a92e350](https://github.com/empathyco/x/commit/a92e3509be65dfce17796efa6fae14a370bc875c)),
+  closes [EX-6844](https://searchbroker.atlassian.net/browse/EX-6844)
+
+# 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.163](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.162...@empathyco/x-components@3.0.0-alpha.163) (2022-08-29)
 
 ### Documentation

package/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/design-system/full-theme.css

@@ -1426,18 +1426,6 @@
   --x-size-border-radius-bottom-right-input-group-pill: var(--x-size-border-radius-input-group-pill);
   --x-size-border-radius-bottom-left-input-group-pill: var(--x-size-border-radius-input-group-pill);
 }
-.x-input--card.x-input,
-.x-input--card .x-input {
-  --x-size-border-radius-input-default: var(--x-size-border-radius-input-card);
-  --x-size-border-radius-top-left-input-default: var(--x-size-border-radius-top-left-input-card);
-  --x-size-border-radius-top-right-input-default: var(--x-size-border-radius-top-right-input-card);
-  --x-size-border-radius-bottom-right-input-default: var(
-    --x-size-border-radius-bottom-right-input-card
-  );
-  --x-size-border-radius-bottom-left-input-default: var(
-    --x-size-border-radius-bottom-left-input-card
-  );
-}
 :root {
   --x-size-border-radius-input-card: var(--x-size-border-radius-base-s);
   --x-size-border-radius-top-left-input-card: var(--x-size-border-radius-input-card);
@@ -7483,3 +7471,16 @@
 .x-normal-case {
   text-transform: none;
 }
+
+.x-input--card.x-input,
+.x-input--card .x-input {
+  --x-size-border-radius-input-default: var(--x-size-border-radius-input-card);
+  --x-size-border-radius-top-left-input-default: var(--x-size-border-radius-top-left-input-card);
+  --x-size-border-radius-top-right-input-default: var(--x-size-border-radius-top-right-input-card);
+  --x-size-border-radius-bottom-right-input-default: var(
+    --x-size-border-radius-bottom-right-input-card
+  );
+  --x-size-border-radius-bottom-left-input-default: var(
+    --x-size-border-radius-bottom-left-input-card
+  );
+}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [clearQueryPreviewWire](./x-components.clearquerypreviewwire.md)
+
+## clearQueryPreviewWire variable
+
+Clears a query preview from queries preview module.
+
+<b>Signature:</b>
+
+```typescript
+clearQueryPreviewWire: import("../..").Wire<string>
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchAndSaveQueryPreview](./x-components.fetchandsavequerypreview.md)
+
+## fetchAndSaveQueryPreview variable
+
+Default implementation for the [QueriesPreviewActions.fetchAndSaveQueryPreview()](./x-components.queriespreviewactions.fetchandsavequerypreview.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+fetchAndSaveQueryPreview: QueriesPreviewXStoreModule['actions']['fetchAndSaveQueryPreview']
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchAndSaveQueryPreviewWire](./x-components.fetchandsavequerypreviewwire.md)
+
+## fetchAndSaveQueryPreviewWire variable
+
+Requests and stores the query preview results.
+
+<b>Signature:</b>
+
+```typescript
+fetchAndSaveQueryPreviewWire: import("../..").Wire<import("@empathyco/x-types").SearchRequest>
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchQueryPreview](./x-components.fetchquerypreview.md)
+
+## fetchQueryPreview variable
+
+Default implementation for the [QueriesPreviewActions.fetchQueryPreview()](./x-components.queriespreviewactions.fetchquerypreview.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+fetchQueryPreview: QueriesPreviewXStoreModule['actions']['fetchQueryPreview']
+```

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

@@ -275,11 +275,14 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [PopularSearchesXEvents](./x-components.popularsearchesxevents.md) | Dictionary of the events of PopularSearches XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
 |  [PrivateXModuleOptions](./x-components.privatexmoduleoptions.md) | Options for overriding the default store module and store emitters for a [XModule](./x-components.xmodule.md)<!-- -->. |
 |  [QueriesPreviewActions](./x-components.queriespreviewactions.md) | QueriesPreview store actions. |
+|  [QueriesPreviewConfig](./x-components.queriespreviewconfig.md) | Configuration options for the [QueriesPreviewXModule](./x-components.queriespreviewxmodule.md)<!-- -->. |
 |  [QueriesPreviewGetters](./x-components.queriespreviewgetters.md) | QueriesPreview store getters. |
 |  [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) | QueriesPreview store mutations. |
 |  [QueriesPreviewState](./x-components.queriespreviewstate.md) | QueriesPreview store state. |
 |  [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md) | Dictionary of the events of QueriesPreview XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
 |  [QueryPreview](./x-components.querypreview.md) | Information to render a query preview with. |
+|  [QueryPreviewItem](./x-components.querypreviewitem.md) | QueriesPreview store state. |
+|  [QueryPreviewStatusPayload](./x-components.querypreviewstatuspayload.md) | Payload to use in the <code>setStatus</code> mutation. |
 |  [QuerySuggestionsActions](./x-components.querysuggestionsactions.md) | QuerySuggestions store actions. |
 |  [QuerySuggestionsConfig](./x-components.querysuggestionsconfig.md) | Configuration options for the [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md)<!-- -->. |
 |  [QuerySuggestionsGetters](./x-components.querysuggestionsgetters.md) | QuerySuggestions store getters. |
@@ -407,6 +410,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [clearHistoryQueriesQuery](./x-components.clearhistoryqueriesquery.md) | Sets the query of the history queries module to an empty string. |
 |  [clearIdentifierResultsQuery](./x-components.clearidentifierresultsquery.md) | Clears the identifier-results module query. |
 |  [clearPendingScrollToWire](./x-components.clearpendingscrolltowire.md) | Resets the selector of the scroll that is pending to restore. |
+|  [clearQueryPreviewWire](./x-components.clearquerypreviewwire.md) | Clears a query preview from queries preview module. |
 |  [clearQuerySuggestionsQuery](./x-components.clearquerysuggestionsquery.md) | Clears the query-suggestions module query. |
 |  [clearRelatedTagsQuery](./x-components.clearrelatedtagsquery.md) | Clear the related tags query. |
 |  [clearSearchQuery](./x-components.clearsearchquery.md) | Clears the search state <code>query</code>. |
@@ -426,6 +430,8 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [fetchAndSaveNextQueriesWire](./x-components.fetchandsavenextquerieswire.md) | Requests and stores the next queries. |
 |  [fetchAndSaveNextQueryPreviewWire](./x-components.fetchandsavenextquerypreviewwire.md) | Requests and store the next query preview results. |
 |  [fetchAndSavePopularSearches](./x-components.fetchandsavepopularsearches.md) | Default implementation for [PopularSearchesActions.fetchAndSaveSuggestions()](./x-components.popularsearchesactions.fetchandsavesuggestions.md) action. |
+|  [fetchAndSaveQueryPreview](./x-components.fetchandsavequerypreview.md) | Default implementation for the [QueriesPreviewActions.fetchAndSaveQueryPreview()](./x-components.queriespreviewactions.fetchandsavequerypreview.md)<!-- -->. |
+|  [fetchAndSaveQueryPreviewWire](./x-components.fetchandsavequerypreviewwire.md) | Requests and stores the query preview results. |
 |  [fetchAndSaveQuerySuggestions](./x-components.fetchandsavequerysuggestions.md) | Default implementation for [QuerySuggestionsActions.fetchAndSaveSuggestions()](./x-components.querysuggestionsactions.fetchandsavesuggestions.md) action. |
 |  [fetchAndSaveRecommendations](./x-components.fetchandsaverecommendations.md) | Default implementation for [RecommendationsActions.fetchAndSaveRecommendations()](./x-components.recommendationsactions.fetchandsaverecommendations.md) action. |
 |  [fetchAndSaveRelatedTags](./x-components.fetchandsaverelatedtags.md) | Default implementation for [RelatedTagsActions.fetchAndSaveRelatedTags()](./x-components.relatedtagsactions.fetchandsaverelatedtags.md) action. |
@@ -436,6 +442,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [fetchIdentifierResults](./x-components.fetchidentifierresults.md) | Default implementation for the [IdentifierResultsActions.fetchIdentifierResults()](./x-components.identifierresultsactions.fetchidentifierresults.md)<!-- -->. |
 |  [fetchNextQueries](./x-components.fetchnextqueries.md) | Default implementation for the [NextQueriesActions.fetchNextQueries()](./x-components.nextqueriesactions.fetchnextqueries.md)<!-- -->. |
 |  [fetchPopularSearches](./x-components.fetchpopularsearches.md) | Default implementation for the [PopularSearchesActions.fetchSuggestions()](./x-components.popularsearchesactions.fetchsuggestions.md)<!-- -->. |
+|  [fetchQueryPreview](./x-components.fetchquerypreview.md) | Default implementation for the [QueriesPreviewActions.fetchQueryPreview()](./x-components.queriespreviewactions.fetchquerypreview.md)<!-- -->. |
 |  [fetchQuerySuggestions](./x-components.fetchquerysuggestions.md) | Default implementation for the [QuerySuggestionsActions.fetchSuggestions()](./x-components.querysuggestionsactions.fetchsuggestions.md)<!-- -->. |
 |  [fetchRecommendations](./x-components.fetchrecommendations.md) | Default implementation for the [RecommendationsActions.fetchRecommendations()](./x-components.recommendationsactions.fetchrecommendations.md)<!-- -->. |
 |  [fetchRelatedTags](./x-components.fetchrelatedtags.md) | Default implementation for the [RelatedTagsActions.fetchRelatedTags()](./x-components.relatedtagsactions.fetchrelatedtags.md)<!-- -->. |
@@ -531,6 +538,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [setParams](./x-components.setparams.md) | Sets the extra params of the url module. |
 |  [setPendingScrollToWire](./x-components.setpendingscrolltowire.md) | Saves the selector of the item that should be scrolled into the view. |
 |  [setPopularSearchesExtraParams](./x-components.setpopularsearchesextraparams.md) | Sets the popular searches state <code>params</code>. |
+|  [setQueriesPreviewExtraParamsWire](./x-components.setqueriespreviewextraparamswire.md) | Sets the queries preview state <code>params</code>. |
 |  [setQueryFromLastHistoryQuery](./x-components.setqueryfromlasthistoryquery.md) | Default implementation for the [NextQueriesActions.setQueryFromLastHistoryQuery()](./x-components.nextqueriesactions.setqueryfromlasthistoryquery.md)<!-- -->. |
 |  [setQueryFromLastHistoryQueryWire](./x-components.setqueryfromlasthistoryquerywire.md) | Sets the next queries state <code>query</code> with the last query in history queries. |
 |  [setQuerySuggestionsExtraParams](./x-components.setquerysuggestionsextraparams.md) | Sets the query suggestions state <code>params</code>. |

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

@@ -9,5 +9,5 @@ Animation component that will be used to animate the suggestions.
 <b>Signature:</b>
 
 ```typescript
-protected animation: Vue;
+animation?: Vue;
 ```

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

@@ -9,5 +9,5 @@ Flag to indicate if the curated next queries should be displayed different.
 <b>Signature:</b>
 
 ```typescript
-protected highlightCurated: boolean;
+highlightCurated: boolean;
 ```

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

@@ -9,5 +9,5 @@ Number of next queries to be rendered.
 <b>Signature:</b>
 
 ```typescript
-protected maxItemsToRender?: number;
+maxItemsToRender?: number;
 ```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueries](./x-components.nextqueries.md) &gt; [suggestions](./x-components.nextqueries.suggestions.md)
+
+## NextQueries.suggestions property
+
+NextQueries list to be used instead of state NextQueries.
+
+<b>Signature:</b>
+
+```typescript
+suggestions?: NextQueryModel[];
+```

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewActions](./x-components.queriespreviewactions.md) &gt; [fetchAndSaveQueryPreview](./x-components.queriespreviewactions.fetchandsavequerypreview.md)
+
+## QueriesPreviewActions.fetchAndSaveQueryPreview() method
+
+Requests the results for a query preview and saves them in the state.
+
+<b>Signature:</b>
+
+```typescript
+fetchAndSaveQueryPreview(request: SearchRequest): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | SearchRequest | The request object to retrieve the query preview. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewActions](./x-components.queriespreviewactions.md) &gt; [fetchQueryPreview](./x-components.queriespreviewactions.fetchquerypreview.md)
+
+## QueriesPreviewActions.fetchQueryPreview() method
+
+Requests the results for a query preview, limited by [QueriesPreviewConfig.maxItemsToRequest](./x-components.queriespreviewconfig.maxitemstorequest.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+fetchQueryPreview(request: SearchRequest): SearchResponse | null;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | SearchRequest | The request object to retrieve the query preview. |
+
+<b>Returns:</b>
+
+SearchResponse \| null
+
+A search response based on the query.
+

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

@@ -11,3 +11,11 @@ QueriesPreview store actions.
 ```typescript
 export interface QueriesPreviewActions 
 ```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [fetchAndSaveQueryPreview(request)](./x-components.queriespreviewactions.fetchandsavequerypreview.md) | Requests the results for a query preview and saves them in the state. |
+|  [fetchQueryPreview(request)](./x-components.queriespreviewactions.fetchquerypreview.md) | Requests the results for a query preview, limited by [QueriesPreviewConfig.maxItemsToRequest](./x-components.queriespreviewconfig.maxitemstorequest.md)<!-- -->. |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewConfig](./x-components.queriespreviewconfig.md) &gt; [maxItemsToRequest](./x-components.queriespreviewconfig.maxitemstorequest.md)
+
+## QueriesPreviewConfig.maxItemsToRequest property
+
+Maximum number of items to request.
+
+<b>Signature:</b>
+
+```typescript
+maxItemsToRequest: number;
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewConfig](./x-components.queriespreviewconfig.md)
+
+## QueriesPreviewConfig interface
+
+Configuration options for the [QueriesPreviewXModule](./x-components.queriespreviewxmodule.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface QueriesPreviewConfig 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [maxItemsToRequest](./x-components.queriespreviewconfig.maxitemstorequest.md) | number | Maximum number of items to request. |
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) &gt; [clearQueryPreview](./x-components.queriespreviewmutations.clearquerypreview.md)
+
+## QueriesPreviewMutations.clearQueryPreview() method
+
+Removes a query preview entry from the queries preview's dictionary.
+
+<b>Signature:</b>
+
+```typescript
+clearQueryPreview(query: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  query | string | Query whose entry will be removed. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -11,3 +11,13 @@ QueriesPreview store mutations.
 ```typescript
 export interface QueriesPreviewMutations 
 ```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [clearQueryPreview(query)](./x-components.queriespreviewmutations.clearquerypreview.md) | Removes a query preview entry from the queries preview's dictionary. |
+|  [setParams(params)](./x-components.queriespreviewmutations.setparams.md) | Sets the extra params of the module. |
+|  [setQueryPreview(queryPreview)](./x-components.queriespreviewmutations.setquerypreview.md) | Adds a new entry to the queries preview's dictionary. |
+|  [setStatus(payload)](./x-components.queriespreviewmutations.setstatus.md) | Sets the status of a query preview request. |
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) &gt; [setParams](./x-components.queriespreviewmutations.setparams.md)
+
+## QueriesPreviewMutations.setParams() method
+
+Sets the extra params of the module.
+
+<b>Signature:</b>
+
+```typescript
+setParams(params: Dictionary<unknown>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | Dictionary&lt;unknown&gt; | The new extra params. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) &gt; [setQueryPreview](./x-components.queriespreviewmutations.setquerypreview.md)
+
+## QueriesPreviewMutations.setQueryPreview() method
+
+Adds a new entry to the queries preview's dictionary.
+
+<b>Signature:</b>
+
+```typescript
+setQueryPreview(queryPreview: QueryPreviewItem): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  queryPreview | [QueryPreviewItem](./x-components.querypreviewitem.md) | The query preview item to add. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) &gt; [setStatus](./x-components.queriespreviewmutations.setstatus.md)
+
+## QueriesPreviewMutations.setStatus() method
+
+Sets the status of a query preview request.
+
+<b>Signature:</b>
+
+```typescript
+setStatus(payload: QueryPreviewStatusPayload): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  payload | [QueryPreviewStatusPayload](./x-components.querypreviewstatuspayload.md) | Object containing the query and the status of a query preview item. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewState](./x-components.queriespreviewstate.md) &gt; [config](./x-components.queriespreviewstate.config.md)
+
+## QueriesPreviewState.config property
+
+The configuration of the queries preview module.
+
+<b>Signature:</b>
+
+```typescript
+config: QueriesPreviewConfig;
+```

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

@@ -11,3 +11,12 @@ QueriesPreview store state.
 ```typescript
 export interface QueriesPreviewState 
 ```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [config](./x-components.queriespreviewstate.config.md) | [QueriesPreviewConfig](./x-components.queriespreviewconfig.md) | The configuration of the queries preview module. |
+|  [params](./x-components.queriespreviewstate.params.md) | Dictionary<unknown> | The extra params property of the state. |
+|  [queriesPreview](./x-components.queriespreviewstate.queriespreview.md) | Dictionary&lt;[QueryPreviewItem](./x-components.querypreviewitem.md)<!-- -->&gt; |  |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewState](./x-components.queriespreviewstate.md) &gt; [params](./x-components.queriespreviewstate.params.md)
+
+## QueriesPreviewState.params property
+
+The extra params property of the state.
+
+<b>Signature:</b>
+
+```typescript
+params: Dictionary<unknown>;
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewState](./x-components.queriespreviewstate.md) &gt; [queriesPreview](./x-components.queriespreviewstate.queriespreview.md)
+
+## QueriesPreviewState.queriesPreview property
+
+<b>Signature:</b>
+
+```typescript
+queriesPreview: Dictionary<QueryPreviewItem>;
+```

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

@@ -11,3 +11,11 @@ Dictionary of the events of QueriesPreview XModule, where each key is the event
 ```typescript
 export interface QueriesPreviewXEvents 
 ```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [QueryPreviewRemoved](./x-components.queriespreviewxevents.querypreviewremoved.md) | string | The component that shows a Query preview has been unmounted. Payload: The query whose preview has been removed. |
+|  [QueryPreviewRequestChanged](./x-components.queriespreviewxevents.querypreviewrequestchanged.md) | SearchRequest | Any property of the queries preview request has changed. Payload: The new [request](./x-types.searchrequest.md)<!-- -->. |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md) &gt; [QueryPreviewRemoved](./x-components.queriespreviewxevents.querypreviewremoved.md)
+
+## QueriesPreviewXEvents.QueryPreviewRemoved property
+
+The component that shows a Query preview has been unmounted. Payload: The query whose preview has been removed.
+
+<b>Signature:</b>
+
+```typescript
+QueryPreviewRemoved: string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md) &gt; [QueryPreviewRequestChanged](./x-components.queriespreviewxevents.querypreviewrequestchanged.md)
+
+## QueriesPreviewXEvents.QueryPreviewRequestChanged property
+
+Any property of the queries preview request has changed. Payload: The new [request](./x-types.searchrequest.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+QueryPreviewRequestChanged: SearchRequest;
+```

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueryPreviewItem](./x-components.querypreviewitem.md)
+
+## QueryPreviewItem interface
+
+QueriesPreview store state.
+
+<b>Signature:</b>
+
+```typescript
+export interface QueryPreviewItem extends StatusState 
+```
+<b>Extends:</b> [StatusState](./x-components.statusstate.md)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [request](./x-components.querypreviewitem.request.md) | SearchRequest | Request object to retrieve the query preview using the search adapter, or null if there is no valid data to conform a valid request. |
+|  [results](./x-components.querypreviewitem.results.md) | Result\[\] | Results of the query preview request. |
+|  [totalResults](./x-components.querypreviewitem.totalresults.md) | number | The total number of results for the search query. |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueryPreviewItem](./x-components.querypreviewitem.md) &gt; [request](./x-components.querypreviewitem.request.md)
+
+## QueryPreviewItem.request property
+
+Request object to retrieve the query preview using the search adapter, or null if there is no valid data to conform a valid request.
+
+<b>Signature:</b>
+
+```typescript
+request: SearchRequest;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueryPreviewItem](./x-components.querypreviewitem.md) &gt; [results](./x-components.querypreviewitem.results.md)
+
+## QueryPreviewItem.results property
+
+Results of the query preview request.
+
+<b>Signature:</b>
+
+```typescript
+results: Result[];
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueryPreviewItem](./x-components.querypreviewitem.md) &gt; [totalResults](./x-components.querypreviewitem.totalresults.md)
+
+## QueryPreviewItem.totalResults property
+
+The total number of results for the search query.
+
+<b>Signature:</b>
+
+```typescript
+totalResults: number;
+```