@empathyco/x-components 3.0.0-alpha.145 → 3.0.0-alpha.148

package/CHANGELOG.md

@@ -3,6 +3,51 @@
 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.148](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.147...@empathyco/x-components@3.0.0-alpha.148) (2022-08-04)
+
+### Features
+
+- **next-queries:** add next query preview component (#631)
+  ([1513ab1](https://github.com/empathyco/x/commit/1513ab1ef0cbcf42d72f483d99815eba76b5eaad)),
+  closes [EX-6646](https://searchbroker.atlassian.net/browse/EX-6646)
+
+# 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.147](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.146...@empathyco/x-components@3.0.0-alpha.147) (2022-08-03)
+
+### ⚠ BREAKING CHANGES
+
+- **facets:** Removed the `setFilter`mutation from `facets` X-Module. Use `mutateFilter` instead.
+- **facets:** Modified the `HierarchicalFilter.children` Model type. Now it is an
+  `Array<HierarchicalFilter>` instead of an array of ids.
+
+### Features
+
+- **facets:** Move filters flattening from `x-adapter-platform` to `x-components`. (#626)
+  ([2bebaeb](https://github.com/empathyco/x/commit/2bebaeb2863fe794f1b3bea924904651b9302ef6)),
+  closes [EX-6484](https://searchbroker.atlassian.net/browse/EX-6484)
+
+# 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.146](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.145...@empathyco/x-components@3.0.0-alpha.146) (2022-08-03)
+
+### Documentation
+
+- bring functional docs from eDocs project (#630)
+  ([27e6dd6](https://github.com/empathyco/x/commit/27e6dd646084983c37fc52894dc95544253405d5)),
+  closes [EX-6237](https://searchbroker.atlassian.net/browse/EX-6237)
+
+# 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.145](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.144...@empathyco/x-components@3.0.0-alpha.145) (2022-08-01)
 
 ### Documentation

package/core/index.js

@@ -118,7 +118,7 @@ export { default as SlidingPanel } from '../js/components/sliding-panel.vue.js';
 export { default as SnippetCallbacks } from '../js/components/snippet-callbacks.vue.js';
 export { XEmit, XOn } from '../js/components/decorators/bus.decorators.js';
 export { Debounce } from '../js/components/decorators/debounce.decorators.js';
-export { LIST_ITEMS_KEY } from '../js/components/decorators/injection.consts.js';
+export { LIST_ITEMS_KEY, QUERY_KEY } from '../js/components/decorators/injection.consts.js';
 export { XInject, XProvide } from '../js/components/decorators/injection.decorators.js';
 export { Getter, State } from '../js/components/decorators/store.decorators.js';
 export { ItemsListInjectionMixin } from '../js/components/items-list-injection.mixin.js';

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

@@ -1445,64 +1445,6 @@
   --x-size-border-radius-bottom-right-input-card: var(--x-size-border-radius-input-card);
   --x-size-border-radius-bottom-left-input-card: var(--x-size-border-radius-input-card);
 }
-[dir="ltr"] .x-input {
-  padding-left: var(--x-size-padding-left-input-default);
-}
-[dir="rtl"] .x-input {
-  padding-right: var(--x-size-padding-left-input-default);
-}
-[dir="ltr"] .x-input {
-  padding-right: var(--x-size-padding-right-input-default);
-}
-[dir="rtl"] .x-input {
-  padding-left: var(--x-size-padding-right-input-default);
-}
-[dir="ltr"] .x-input {
-  border-right-width: var(--x-size-border-width-right-input-default);
-}
-[dir="rtl"] .x-input {
-  border-left-width: var(--x-size-border-width-right-input-default);
-}
-[dir="ltr"] .x-input {
-  border-left-width: var(--x-size-border-width-left-input-default);
-}
-[dir="rtl"] .x-input {
-  border-right-width: var(--x-size-border-width-left-input-default);
-}
-.x-input {
-  box-sizing: border-box;
-  margin: 0;
-  min-width: 0;
-  height: var(--x-size-height-input-default);
-  padding-top: 0;
-  padding-bottom: 0;
-  background-color: var(--x-color-background-input-default);
-  border-color: var(--x-color-border-input-default);
-  color: var(--x-color-text-input-default);
-  border-top-width: var(--x-size-border-width-top-input-default);
-  border-bottom-width: var(--x-size-border-width-bottom-input-default);
-  border-radius: var(--x-size-border-radius-top-left-input-default) var(--x-size-border-radius-top-right-input-default) var(--x-size-border-radius-bottom-right-input-default) var(--x-size-border-radius-bottom-left-input-default);
-  border-style: solid;
-  font-family: var(--x-font-family-input-default);
-  font-size: var(--x-size-font-input-default);
-  font-weight: var(--x-number-font-weight-input-default);
-  line-height: var(--x-size-line-height-input-default);
-}
-@media not all and (min-resolution: 0.001dpcm) {
-  .x-input {
-    -webkit-appearance: none;
-  }
-}
-.x-input:focus {
-  border-color: var(--x-color-border-input-default-focus);
-}
-.x-input::placeholder {
-  color: var(--x-color-text-input-placeholder-default);
-  font-family: var(--x-font-family-input-placeholder-default);
-  font-size: var(--x-size-font-input-placeholder-default);
-  font-weight: var(--x-number-font-weight-input-placeholder-default);
-  line-height: var(--x-size-line-height-input-placeholder-default);
-}
 :root {
   --x-color-background-input-default: var(--x-color-base-neutral-100);
   --x-color-border-input-default: var(--x-color-base-neutral-70);
@@ -7593,3 +7535,62 @@
 .x-normal-case {
   text-transform: none;
 }
+
+[dir="ltr"] .x-input {
+  padding-left: var(--x-size-padding-left-input-default);
+}
+[dir="rtl"] .x-input {
+  padding-right: var(--x-size-padding-left-input-default);
+}
+[dir="ltr"] .x-input {
+  padding-right: var(--x-size-padding-right-input-default);
+}
+[dir="rtl"] .x-input {
+  padding-left: var(--x-size-padding-right-input-default);
+}
+[dir="ltr"] .x-input {
+  border-right-width: var(--x-size-border-width-right-input-default);
+}
+[dir="rtl"] .x-input {
+  border-left-width: var(--x-size-border-width-right-input-default);
+}
+[dir="ltr"] .x-input {
+  border-left-width: var(--x-size-border-width-left-input-default);
+}
+[dir="rtl"] .x-input {
+  border-right-width: var(--x-size-border-width-left-input-default);
+}
+.x-input {
+  box-sizing: border-box;
+  margin: 0;
+  min-width: 0;
+  height: var(--x-size-height-input-default);
+  padding-top: 0;
+  padding-bottom: 0;
+  background-color: var(--x-color-background-input-default);
+  border-color: var(--x-color-border-input-default);
+  color: var(--x-color-text-input-default);
+  border-top-width: var(--x-size-border-width-top-input-default);
+  border-bottom-width: var(--x-size-border-width-bottom-input-default);
+  border-radius: var(--x-size-border-radius-top-left-input-default) var(--x-size-border-radius-top-right-input-default) var(--x-size-border-radius-bottom-right-input-default) var(--x-size-border-radius-bottom-left-input-default);
+  border-style: solid;
+  font-family: var(--x-font-family-input-default);
+  font-size: var(--x-size-font-input-default);
+  font-weight: var(--x-number-font-weight-input-default);
+  line-height: var(--x-size-line-height-input-default);
+}
+@media not all and (min-resolution: 0.001dpcm) {
+  .x-input {
+    -webkit-appearance: none;
+  }
+}
+.x-input:focus {
+  border-color: var(--x-color-border-input-default-focus);
+}
+.x-input::placeholder {
+  color: var(--x-color-text-input-placeholder-default);
+  font-family: var(--x-font-family-input-placeholder-default);
+  font-size: var(--x-size-font-input-placeholder-default);
+  font-weight: var(--x-number-font-weight-input-placeholder-default);
+  line-height: var(--x-size-line-height-input-placeholder-default);
+}

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

@@ -11,7 +11,6 @@
 |  [extractUrlParameters(url)](./x-adapter-platform.extracturlparameters.md) | Returns the base url path and an object with the query parameters. |
 |  [getFacetConfig(facet)](./x-adapter-platform.getfacetconfig.md) | Returns the facet's config. |
 |  [getTaggingInfoFromUrl(taggingUrl)](./x-adapter-platform.gettagginginfofromurl.md) | Extracts the tagging info from a URL. |
-|  [searchResponseFacetsMapper(from, { mappedValue })](./x-adapter-platform.searchresponsefacetsmapper.md) | Mapper to flatten hierarchical facet filters. |
 
 ## Interfaces
 

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

@@ -7,15 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-searchResponseMapper: import("@empathyco/x-adapter").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;
-}>
+searchResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformSearchResponse, SearchResponse>
 ```

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

@@ -16,12 +16,12 @@ export interface FacetsMutations
 
 |  Method | Description |
 |  --- | --- |
+|  [mutateFilter(payload)](./x-components.facetsmutations.mutatefilter.md) | Updates the state of a filter. |
 |  [removeFacet(facet)](./x-components.facetsmutations.removefacet.md) | Removes the facet from the [facets](./x-components.facetsstate.facets.md) record. |
 |  [removeFilter(filter)](./x-components.facetsmutations.removefilter.md) | Removes the filter from the [filters](./x-components.facetsstate.filters.md) record. |
 |  [removeFilters(filters)](./x-components.facetsmutations.removefilters.md) | Removes a list of filters from the [filters](./x-components.facetsstate.filters.md) record. |
 |  [setFacet(facet)](./x-components.facetsmutations.setfacet.md) | Adds the facet to the [facets](./x-components.facetsstate.facets.md) record. |
 |  [setFacetGroup(facetGroupEntry)](./x-components.facetsmutations.setfacetgroup.md) | Sets the group id of the facet. |
-|  [setFilter(filter)](./x-components.facetsmutations.setfilter.md) | Adds the filter to the [filters](./x-components.facetsstate.filters.md) record. |
 |  [setFilters(filters)](./x-components.facetsmutations.setfilters.md) | Adds a list of filters to the [filters](./x-components.facetsstate.filters.md) record. |
 |  [setPreselectedFilters(filters)](./x-components.facetsmutations.setpreselectedfilters.md) | Adds a list of filters to the [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) record. |
 

package/docs/API-reference/api/x-components.facetsmutations.mutatefilter.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; [FacetsMutations](./x-components.facetsmutations.md) &gt; [mutateFilter](./x-components.facetsmutations.mutatefilter.md)
+
+## FacetsMutations.mutateFilter() method
+
+Updates the state of a filter.
+
+<b>Signature:</b>
+
+```typescript
+mutateFilter(payload: MutateFilterPayload): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  payload | [MutateFilterPayload](./x-components.mutatefilterpayload.md) | An object containing the filter to update, and the properties to modify. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.flathierarchicalfilters.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; [flatHierarchicalFilters](./x-components.flathierarchicalfilters.md)
+
+## flatHierarchicalFilters() function
+
+This function flattens the Hierarchical Filters, returning an array with all filters including the children.
+
+<b>Signature:</b>
+
+```typescript
+export declare function flatHierarchicalFilters(hierarchicalFilters: HierarchicalFilter[]): HierarchicalFilter[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  hierarchicalFilters | HierarchicalFilter\[\] | The list of Hierarchical Filters to flatten. |
+
+<b>Returns:</b>
+
+HierarchicalFilter\[\]
+
+An array with all the Hierarchical filters.
+

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

@@ -94,6 +94,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [NextQueries](./x-components.nextqueries.md) | Simple next-queries component that renders a list of suggestions, allowing the user to select one of them, and emitting the needed events. A next query is a suggestion for a new search, related to your previous query. I.e. If people normally search for <code>shirts</code>, and then <code>trousers</code>, <code>trousers</code> would be a next query of <code>shirts</code>. |
 |  [NextQueriesList](./x-components.nextquerieslist.md) | Component that inserts groups of next queries in different positions of the injected search items list, based on the provided configuration. |
 |  [NextQuery](./x-components.nextquery.md) | Renders a next query item which receives the suggestion that will be rendered as a prop. It exposes a default slot to change the next query content. If the slot is not overridden, it will render the suggestion query by default. |
+|  [NextQueryPreview](./x-components.nextquerypreview.md) | Retrieves a preview of the results of a next query and exposes them in the default slot, along with the next query and the totalResults of the search request. By default, it renders the names of the results. |
 |  [NumberRangeFilter](./x-components.numberrangefilter.md) | Renders a number range filter, emitting the needed events when clicked. |
 |  [OpenMainModal](./x-components.openmainmodal.md) | Button to open the [MainModal](./x-components.mainmodal.md)<!-- -->. |
 |  [PartialQueryButton](./x-components.partialquerybutton.md) | A button that when pressed emits the [XEventsTypes.UserAcceptedAQuery](./x-components.xeventstypes.useracceptedaquery.md) and [SearchXEvents.UserClickedPartialQuery](./x-components.searchxevents.userclickedpartialquery.md) events, expressing the user intention to set the partial query. |
@@ -166,6 +167,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [filterFalsyPayload(wire)](./x-components.filterfalsypayload.md) | Creates a [Wire](./x-components.wire.md) that is only executed when the payload is truthy. A truthy value is whatever is not a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->. |
 |  [filterTruthyPayload(wire)](./x-components.filtertruthypayload.md) | Creates a [Wire](./x-components.wire.md) that is only executed when the payload is a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->. |
 |  [filterWhitelistedModules(wire, whitelist)](./x-components.filterwhitelistedmodules.md) | Creates a [Wire](./x-components.wire.md) that is only executed if the event is emitted from a [XModule](./x-components.xmodule.md) that is included in the <code>whitelist</code> array passed as parameter. |
+|  [flatHierarchicalFilters(hierarchicalFilters)](./x-components.flathierarchicalfilters.md) | This function flattens the Hierarchical Filters, returning an array with all filters including the children. |
 |  [getRootXComponent(component)](./x-components.getrootxcomponent.md) | Given a component, finds the root XComponent in the ancestors hierarchy. |
 |  [getStateAndGettersFromModule(state, getters, moduleName)](./x-components.getstateandgettersfrommodule.md) | Returns an object with the getters and state of a module of store defined by the moduleName parameter. |
 |  [Getter(module, getter)](./x-components.getter.md) | Generates a computed property which returns the selected getter value.<!-- -->The decorated property needs to be public for type inference to work. |
@@ -253,6 +255,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [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-types.searchrequest.md)<!-- -->. |
+|  [MutateFilterPayload](./x-components.mutatefilterpayload.md) | Payload to use in the <code>mutateFilter</code> mutation. |
 |  [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.mutatefilterpayload.filter.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; [MutateFilterPayload](./x-components.mutatefilterpayload.md) &gt; [filter](./x-components.mutatefilterpayload.filter.md)
+
+## MutateFilterPayload.filter property
+
+The filter to modify. If it does not belong to the store it will be added.
+
+<b>Signature:</b>
+
+```typescript
+filter: Filter;
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [MutateFilterPayload](./x-components.mutatefilterpayload.md)
+
+## MutateFilterPayload interface
+
+Payload to use in the `mutateFilter` mutation.
+
+<b>Signature:</b>
+
+```typescript
+export interface MutateFilterPayload 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [filter](./x-components.mutatefilterpayload.filter.md) | Filter | The filter to modify. If it does not belong to the store it will be added. |
+|  [newFilterState](./x-components.mutatefilterpayload.newfilterstate.md) | Partial&lt;Filter&gt; | The new fields values to modify in the filter. |
+

package/docs/API-reference/api/x-components.mutatefilterpayload.newfilterstate.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; [MutateFilterPayload](./x-components.mutatefilterpayload.md) &gt; [newFilterState](./x-components.mutatefilterpayload.newfilterstate.md)
+
+## MutateFilterPayload.newFilterState property
+
+The new fields values to modify in the filter.
+
+<b>Signature:</b>
+
+```typescript
+newFilterState: Partial<Filter>;
+```

package/docs/API-reference/api/x-components.nextquerieslist.injectedquery.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; [NextQueriesList](./x-components.nextquerieslist.md) &gt; [injectedQuery](./x-components.nextquerieslist.injectedquery.md)
+
+## NextQueriesList.injectedQuery property
+
+Injected query, updated when the related request(s) have succeeded.
+
+<b>Signature:</b>
+
+```typescript
+injectedQuery: string | undefined;
+```

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

@@ -19,6 +19,7 @@ export default class NextQueriesList extends NextQueriesList_base
 |  --- | --- | --- | --- |
 |  [animation?](./x-components.nextquerieslist.animation.md) |  | Vue \| string | <i>(Optional)</i> Animation component that will be used to animate the next queries groups. |
 |  [frequency](./x-components.nextquerieslist.frequency.md) |  | number | The items cycle size to keep inserting next queries groups at. |
+|  [injectedQuery](./x-components.nextquerieslist.injectedquery.md) |  | string \| undefined | Injected query, updated when the related request(s) have succeeded. |
 |  [maxGroups](./x-components.nextquerieslist.maxgroups.md) |  | number | The maximum number of groups to insert into the injected list items list. |
 |  [maxNextQueriesPerGroup](./x-components.nextquerieslist.maxnextqueriespergroup.md) |  | number | The maximum amount of next queries to add in a single group. |
 |  [offset](./x-components.nextquerieslist.offset.md) |  | number | The first index to insert a group of next queries at. |

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

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueryPreview](./x-components.nextquerypreview.md)
+
+## NextQueryPreview class
+
+Retrieves a preview of the results of a next query and exposes them in the default slot, along with the next query and the totalResults of the search request. By default, it renders the names of the results.
+
+<b>Signature:</b>
+
+```typescript
+export default class NextQueryPreview extends Vue 
+```
+<b>Extends:</b> Vue
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [previewResults](./x-components.nextquerypreview.previewresults.md) |  | Dictionary&lt;PreviewResults&gt; | The results preview of the next queries mounted. It is a dictionary, indexed by the next query query. |
+|  [suggestion](./x-components.nextquerypreview.suggestion.md) |  | NextQuery | The next query to retrieve the results preview. |
+|  [suggestionResults](./x-components.nextquerypreview.suggestionresults.md) |  | PreviewResults | Gets from the state the results preview of the next query. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [mounted()](./x-components.nextquerypreview.mounted.md) |  | The component emits the NextQueryPreviewMounted event to retrieve the results preview of the next query. |
+

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueryPreview](./x-components.nextquerypreview.md) &gt; [mounted](./x-components.nextquerypreview.mounted.md)
+
+## NextQueryPreview.mounted() method
+
+The component emits the NextQueryPreviewMounted event to retrieve the results preview of the next query.
+
+<b>Signature:</b>
+
+```typescript
+mounted(): void;
+```
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.nextquerypreview.previewresults.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; [NextQueryPreview](./x-components.nextquerypreview.md) &gt; [previewResults](./x-components.nextquerypreview.previewresults.md)
+
+## NextQueryPreview.previewResults property
+
+The results preview of the next queries mounted. It is a dictionary, indexed by the next query query.
+
+<b>Signature:</b>
+
+```typescript
+previewResults: Dictionary<PreviewResults>;
+```

package/docs/API-reference/api/x-components.nextquerypreview.suggestion.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; [NextQueryPreview](./x-components.nextquerypreview.md) &gt; [suggestion](./x-components.nextquerypreview.suggestion.md)
+
+## NextQueryPreview.suggestion property
+
+The next query to retrieve the results preview.
+
+<b>Signature:</b>
+
+```typescript
+protected suggestion: NextQuery;
+```

package/docs/API-reference/api/x-components.nextquerypreview.suggestionresults.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; [NextQueryPreview](./x-components.nextquerypreview.md) &gt; [suggestionResults](./x-components.nextquerypreview.suggestionresults.md)
+
+## NextQueryPreview.suggestionResults property
+
+Gets from the state the results preview of the next query.
+
+<b>Signature:</b>
+
+```typescript
+get suggestionResults(): PreviewResults;
+```

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

@@ -25,4 +25,13 @@ export default class ResultsList extends Vue implements InfiniteScroll
 |  --- | --- | --- | --- |
 |  [animation](./x-components.resultslist.animation.md) |  | Vue \| string | Animation component that will be used to animate the results. |
 |  [items](./x-components.resultslist.items.md) |  | Result\[\] | The results to render from the state. |
+|  [providedQuery](./x-components.resultslist.providedquery.md) |  | string | It provides the search query. This query is updated only when the search request has succeeded. |
+|  [searchQuery](./x-components.resultslist.searchquery.md) |  | string | The query of the search request, taken from the state. |
+|  [searchStatus](./x-components.resultslist.searchstatus.md) |  | [RequestStatus](./x-components.requeststatus.md) | The status of the search request, taken from the state. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [updateQuery(status)](./x-components.resultslist.updatequery.md) |  | Updates the query to be provided to the child components when the search request has succeeded. |
 

package/docs/API-reference/api/x-components.resultslist.providedquery.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; [ResultsList](./x-components.resultslist.md) &gt; [providedQuery](./x-components.resultslist.providedquery.md)
+
+## ResultsList.providedQuery property
+
+It provides the search query. This query is updated only when the search request has succeeded.
+
+<b>Signature:</b>
+
+```typescript
+providedQuery: string;
+```

package/docs/API-reference/api/x-components.resultslist.searchquery.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; [ResultsList](./x-components.resultslist.md) &gt; [searchQuery](./x-components.resultslist.searchquery.md)
+
+## ResultsList.searchQuery property
+
+The query of the search request, taken from the state.
+
+<b>Signature:</b>
+
+```typescript
+searchQuery: string;
+```

package/docs/API-reference/api/x-components.resultslist.searchstatus.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; [ResultsList](./x-components.resultslist.md) &gt; [searchStatus](./x-components.resultslist.searchstatus.md)
+
+## ResultsList.searchStatus property
+
+The status of the search request, taken from the state.
+
+<b>Signature:</b>
+
+```typescript
+searchStatus: RequestStatus;
+```

package/docs/API-reference/api/x-components.resultslist.updatequery.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; [ResultsList](./x-components.resultslist.md) &gt; [updateQuery](./x-components.resultslist.updatequery.md)
+
+## ResultsList.updateQuery() method
+
+Updates the query to be provided to the child components when the search request has succeeded.
+
+<b>Signature:</b>
+
+```typescript
+updateQuery(status: RequestStatus): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  status | [RequestStatus](./x-components.requeststatus.md) | The status of the search request. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -4,10 +4,10 @@
 
 ## HierarchicalFilter.children property
 
-Descendants filters id.
+Descendants filters.
 
 <b>Signature:</b>
 
 ```typescript
-children?: Filter['id'][];
+children?: HierarchicalFilter[];
 ```

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

@@ -17,7 +17,7 @@ export interface HierarchicalFilter extends BooleanFilter
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [children?](./x-types.hierarchicalfilter.children.md) | [Filter](./x-types.filter.md)<!-- -->\['id'\]\[\] | <i>(Optional)</i> Descendants filters id. |
+|  [children?](./x-types.hierarchicalfilter.children.md) | [HierarchicalFilter](./x-types.hierarchicalfilter.md)<!-- -->\[\] | <i>(Optional)</i> Descendants filters. |
 |  [modelName](./x-types.hierarchicalfilter.modelname.md) | 'HierarchicalFilter' | Model name to indicate the filter type. |
-|  [parentId](./x-types.hierarchicalfilter.parentid.md) | [Filter](./x-types.filter.md)<!-- -->\['id'\] \| null | An unique id used to reference the parent filter or null if it hasn't. |
+|  [parentId](./x-types.hierarchicalfilter.parentid.md) | [Filter](./x-types.filter.md)<!-- -->\['id'\] \| null | A unique id used to reference the parent filter or null if it hasn't. |
 

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

@@ -4,7 +4,7 @@
 
 ## HierarchicalFilter.parentId property
 
-An unique id used to reference the parent filter or null if it hasn't.
+A unique id used to reference the parent filter or null if it hasn't.
 
 <b>Signature:</b>