@empathyco/x-components 6.0.0-alpha.2 → 6.0.0-alpha.21

package/docs/API-reference/api/x-components.relatedpromptsstate.selectedprompt.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; [RelatedPromptsState](./x-components.relatedpromptsstate.md) &gt; [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md)
+
+## RelatedPromptsState.selectedPrompt property
+
+The index of the selected related-prompt.
+
+**Signature:**
+
+```typescript
+selectedPrompt: number;
+```

package/docs/API-reference/api/x-components.relatedpromptsstate.selectedquery.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; [RelatedPromptsState](./x-components.relatedpromptsstate.md) &gt; [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md)
+
+## RelatedPromptsState.selectedQuery property
+
+The index of the selected next query.
+
+**Signature:**
+
+```typescript
+selectedQuery: number;
+```

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)
+
+## RelatedPromptsXEvents interface
+
+Dictionary of the events of RelatedPrompts XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload.
+
+**Signature:**
+
+```typescript
+export interface RelatedPromptsXEvents 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [RelatedPromptsRequestUpdated](./x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md) |  | RelatedPromptsRequest \| null | Any property of the related-prompts request has changed Payload: The new related-prompts request or <code>null</code> if there is not enough data in the state to conform a valid request. |
+|  [UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md) |  | number | The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection. |
+|  [UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md) |  | number | The selected next query of the selected prompt has changed. Payload: The index of the next query in the NextQueries list or -1 to remove selection. |
+

package/docs/API-reference/api/x-components.relatedpromptsxevents.relatedpromptsrequestupdated.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; [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md) &gt; [RelatedPromptsRequestUpdated](./x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md)
+
+## RelatedPromptsXEvents.RelatedPromptsRequestUpdated property
+
+Any property of the related-prompts request has changed Payload: The new related-prompts request or `null` if there is not enough data in the state to conform a valid request.
+
+**Signature:**
+
+```typescript
+RelatedPromptsRequestUpdated: RelatedPromptsRequest | null;
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedprompt.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; [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md) &gt; [UserSelectedARelatedPrompt](./x-components.relatedpromptsxevents.userselectedarelatedprompt.md)
+
+## RelatedPromptsXEvents.UserSelectedARelatedPrompt property
+
+The selected prompt has changed. Payload: The index of the prompt in the RelatedPrompts list or -1 to remove selection.
+
+**Signature:**
+
+```typescript
+UserSelectedARelatedPrompt: number;
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedpromptquery.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; [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md) &gt; [UserSelectedARelatedPromptQuery](./x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md)
+
+## RelatedPromptsXEvents.UserSelectedARelatedPromptQuery property
+
+The selected next query of the selected prompt has changed. Payload: The index of the next query in the NextQueries list or -1 to remove selection.
+
+**Signature:**
+
+```typescript
+UserSelectedARelatedPromptQuery: number;
+```

package/docs/API-reference/api/x-components.relatedpromptsxmodule.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; [relatedPromptsXModule](./x-components.relatedpromptsxmodule.md)
+
+## relatedPromptsXModule variable
+
+Related Prompts [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `related-prompts` entry point.
+
+**Signature:**
+
+```typescript
+relatedPromptsXModule: RelatedPromptsXModule
+```

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsXStoreModule](./x-components.relatedpromptsxstoremodule.md)
+
+## RelatedPromptsXStoreModule type
+
+Related prompts store module.
+
+**Signature:**
+
+```typescript
+export type RelatedPromptsXStoreModule = XStoreModule<RelatedPromptsState, RelatedPromptsGetters, RelatedPromptsMutations, RelatedPromptsActions>;
+```
+**References:** [XStoreModule](./x-components.xstoremodule.md)<!-- -->, [RelatedPromptsState](./x-components.relatedpromptsstate.md)<!-- -->, [RelatedPromptsGetters](./x-components.relatedpromptsgetters.md)<!-- -->, [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md)<!-- -->, [RelatedPromptsActions](./x-components.relatedpromptsactions.md)
+

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

@@ -11,7 +11,7 @@ This component renders a set of \[`RelatedTag`<!-- -->\](./x-components.related-
 ```typescript
 _default: import("vue").DefineComponent<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
     maxItemsToRender: NumberConstructor;
@@ -24,7 +24,7 @@ _default: import("vue").DefineComponent<{
     relatedTags: ComputedRef<RelatedTagModel[]>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
     maxItemsToRender: NumberConstructor;
@@ -34,7 +34,7 @@ _default: import("vue").DefineComponent<{
     };
     itemClass: StringConstructor;
 }>>, {
-    animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    animation: string | Function | Record<string, any>;
     highlightCurated: boolean;
 }, {}>
 ```

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

@@ -15,19 +15,19 @@ It also provides the slot result to customize the item, which is within the defa
 ```typescript
 _default: import("vue").DefineComponent<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
 }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "UserReachedResultsListEnd"[], "UserReachedResultsListEnd", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
 }>> & {
     onUserReachedResultsListEnd?: ((...args: any[]) => any) | undefined;
 }, {
-    animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    animation: string | Function | Record<string, any>;
 }, {}>
 ```

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

@@ -11,8 +11,8 @@ The `ScrollToTop` component is a button that the user can click to make a contai
 ```typescript
 _default: import("vue").DefineComponent<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
-        default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+        default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     thresholdPx: NumberConstructor;
     scrollId: {
@@ -24,8 +24,8 @@ _default: import("vue").DefineComponent<{
     isVisible: import("vue").ComputedRef<any>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     animation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
-        default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+        default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     thresholdPx: NumberConstructor;
     scrollId: {
@@ -33,7 +33,7 @@ _default: import("vue").DefineComponent<{
         default: string;
     };
 }>>, {
-    animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    animation: string | Function | Record<string, any>;
     scrollId: string;
 }, {}>
 ```

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

@@ -15,7 +15,7 @@ _default: import("vue").DefineComponent<{
         required: true;
     };
     animation: {
-        type: PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     animationIntervalMs: {
@@ -32,7 +32,7 @@ _default: import("vue").DefineComponent<{
         required: true;
     };
     animation: {
-        type: PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     animationIntervalMs: {
@@ -41,7 +41,7 @@ _default: import("vue").DefineComponent<{
     };
     animateOnlyOnHover: BooleanConstructor;
 }>>, {
-    animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    animation: string | Function | Record<string, any>;
     animationIntervalMs: number;
     animateOnlyOnHover: boolean;
 }, {}>

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

@@ -38,6 +38,7 @@ export interface SearchMutations extends StatusMutations, QueryMutations, Config
 |  [setSelectedFilters(selectedFilters)](./x-components.searchmutations.setselectedfilters.md) | Sets the selected filters of the module. |
 |  [setSort(sort)](./x-components.searchmutations.setsort.md) | Sets the selected sort option of the module. |
 |  [setSpellcheck(spellcheckedQuery)](./x-components.searchmutations.setspellcheck.md) | Sets the spellcheckedQuery of the module. |
+|  [setStats(stats)](./x-components.searchmutations.setstats.md) | Sets the stats of the module. |
 |  [setTotalResults(totalResults)](./x-components.searchmutations.settotalresults.md) | Sets the total results of the module. |
 |  [updateResult(result)](./x-components.searchmutations.updateresult.md) | Updates a result with new fields. |
 

package/docs/API-reference/api/x-components.searchmutations.setstats.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; [SearchMutations](./x-components.searchmutations.md) &gt; [setStats](./x-components.searchmutations.setstats.md)
+
+## SearchMutations.setStats() method
+
+Sets the stats of the module.
+
+**Signature:**
+
+```typescript
+setStats(stats: Stats): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stats | Stats | The new stats to save to the state. |
+
+**Returns:**
+
+void
+

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

@@ -36,5 +36,6 @@ export interface SearchState extends StatusState, QueryState
 |  [selectedFilters](./x-components.searchstate.selectedfilters.md) |  | Dictionary<Filter\[\]> | The dictionary of selected filters, used to perform the search request. The key is the facet id, and the value the list of filters for that facet. |
 |  [sort](./x-components.searchstate.sort.md) |  | Sort | The way of ordering the results. |
 |  [spellcheckedQuery](./x-components.searchstate.spellcheckedquery.md) |  | string | The spellcheckedQuery property of the state. |
+|  [stats](./x-components.searchstate.stats.md) |  | Stats | The stats of the results. |
 |  [totalResults](./x-components.searchstate.totalresults.md) |  | number | The total number of results, related to the <code>query</code> property of the state. |
 

package/docs/API-reference/api/x-components.searchstate.stats.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; [SearchState](./x-components.searchstate.md) &gt; [stats](./x-components.searchstate.stats.md)
+
+## SearchState.stats property
+
+The stats of the results.
+
+**Signature:**
+
+```typescript
+stats: Stats;
+```

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

@@ -17,7 +17,7 @@ _default: import("vue").DefineComponent<{
     facetsIds: PropType<(string | number)[]>;
     alwaysVisible: BooleanConstructor;
     animation: {
-        type: PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
 }, {
@@ -28,11 +28,11 @@ _default: import("vue").DefineComponent<{
     facetsIds: PropType<(string | number)[]>;
     alwaysVisible: BooleanConstructor;
     animation: {
-        type: PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: string;
     };
 }>>, {
     alwaysVisible: boolean;
-    animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    animation: string | Function | Record<string, any>;
 }, {}>
 ```

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

@@ -180,6 +180,9 @@ _default: import("vue").DefineComponent<{
         ExtraParamsLoadedFromUrl?: Dictionary<unknown> | undefined;
         PushableUrlStateUpdated?: import("../../../..").UrlParams | undefined;
         ReplaceableUrlStateUpdated?: import("../../../..").UrlParams | undefined;
+        RelatedPromptsRequestUpdated?: import("@empathyco/x-types").RelatedPromptsRequest | null | undefined;
+        UserSelectedARelatedPrompt?: number | undefined;
+        UserSelectedARelatedPromptQuery?: number | undefined;
     }>;
     innerCssClasses: import("vue").ComputedRef<(string | Dictionary<boolean>)[]>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{

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

@@ -16,18 +16,18 @@ Component for use as Layout to be filled with the rest of the Components.
 ```typescript
 _default: import("vue").DefineComponent<{
     asideAnimation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     devMode: BooleanConstructor;
 }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     asideAnimation: {
-        type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
         default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
     };
     devMode: BooleanConstructor;
 }>>, {
-    asideAnimation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+    asideAnimation: string | Function | Record<string, any>;
     devMode: boolean;
 }, {}>
 ```

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

@@ -170,6 +170,9 @@ _default: import("vue").DefineComponent<{}, {
         ExtraParamsLoadedFromUrl: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
         PushableUrlStateUpdated: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
         ReplaceableUrlStateUpdated: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
+        RelatedPromptsRequestUpdated: (payload: import("@empathyco/x-types").RelatedPromptsRequest | null, metadata: WireMetadata) => unknown;
+        UserSelectedARelatedPrompt: (payload: number, metadata: WireMetadata) => unknown;
+        UserSelectedARelatedPromptQuery: (payload: number, metadata: WireMetadata) => unknown;
     }>>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
 ```

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

@@ -16,7 +16,7 @@ _default: import("vue").DefineComponent<{
         default: () => Array<keyof SnippetConfig>;
     };
 }, {
-    extraParams: import("vue").Ref<{}>;
+    extraParams: import("vue").Ref<Record<string, any>>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     values: {
         type: PropType<Dictionary<unknown>>;

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

@@ -17,7 +17,7 @@ _default: Vue.DefineComponent<{
     animation: Vue.PropType<string | typeof Vue>;
 }, {
     emitUserClickedASort: (sort: Sort) => void;
-    rootRef: Vue.Ref<Vue.DefineComponent<{}, {}, {}, Vue.ComputedOptions, Vue.MethodOptions, Vue.ComponentOptionsMixin, Vue.ComponentOptionsMixin, {}, string, Vue.PublicProps, Readonly<Vue.ExtractPropTypes<{}>>, {}, {}> | undefined>;
+    rootRef: Vue.Ref<Vue.DefineComponent<{}, {}, any, Vue.ComputedOptions, Vue.MethodOptions, Vue.ComponentOptionsMixin, Vue.ComponentOptionsMixin, {}, string, Vue.PublicProps, Readonly<Vue.ExtractPropTypes<{}>>, {}, {}> | undefined>;
     selectedSort: Vue.ComputedRef<any>;
 }, unknown, {}, {}, Vue.ComponentOptionsMixin, Vue.ComponentOptionsMixin, "change"[], "change", Vue.PublicProps, Readonly<Vue.ExtractPropTypes<{
     items: {

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

@@ -19,8 +19,14 @@ _default: import("vue").DefineComponent<{
         default: string;
     };
     sessionTTLMs: NumberConstructor;
-    queryTaggingDebounceMs: NumberConstructor;
-    consent: BooleanConstructor;
+    queryTaggingDebounceMs: {
+        type: NumberConstructor;
+        default: number;
+    };
+    consent: {
+        type: BooleanConstructor;
+        default: null;
+    };
 }, () => void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     clickedResultStorageTTLMs: {
         type: NumberConstructor;
@@ -31,11 +37,18 @@ _default: import("vue").DefineComponent<{
         default: string;
     };
     sessionTTLMs: NumberConstructor;
-    queryTaggingDebounceMs: NumberConstructor;
-    consent: BooleanConstructor;
+    queryTaggingDebounceMs: {
+        type: NumberConstructor;
+        default: number;
+    };
+    consent: {
+        type: BooleanConstructor;
+        default: null;
+    };
 }>>, {
     clickedResultStorageTTLMs: number;
     clickedResultStorageKey: string;
+    queryTaggingDebounceMs: number;
     consent: boolean;
 }, {}>
 ```

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

@@ -30,6 +30,7 @@ export interface UseAliasAPI
 |  [noResults](./x-components.usealiasapi.noresults.md) | <code>readonly</code> | boolean | The [SearchXModule](./x-components.searchxmodule.md) no results situation. |
 |  [partialResults](./x-components.usealiasapi.partialresults.md) | <code>readonly</code> | ReadonlyArray&lt;PartialResult&gt; | The [SearchXModule](./x-components.searchxmodule.md) partial results. |
 |  [popularSearches](./x-components.usealiasapi.popularsearches.md) | <code>readonly</code> | ReadonlyArray&lt;Suggestion&gt; | The [PopularSearchesXModule](./x-components.popularsearchesxmodule.md) popular searches. |
+|  [priceStats](./x-components.usealiasapi.pricestats.md) | <code>readonly</code> | { min: number; max: number; } | The [SearchXModule](./x-components.searchxmodule.md) price specific stats. |
 |  [query](./x-components.usealiasapi.query.md) | <code>readonly</code> | [UseAliasQueryAPI](./x-components.usealiasqueryapi.md) | The query value of the different modules. |
 |  [querySuggestions](./x-components.usealiasapi.querysuggestions.md) | <code>readonly</code> | ReadonlyArray&lt;Suggestion&gt; | The [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) query suggestions that should be displayed. |
 |  [recommendations](./x-components.usealiasapi.recommendations.md) | <code>readonly</code> | ReadonlyArray&lt;Result&gt; | The [RecommendationsXModule](./x-components.recommendationsxmodule.md) recommendations. |

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [UseAliasAPI](./x-components.usealiasapi.md) &gt; [priceStats](./x-components.usealiasapi.pricestats.md)
+
+## UseAliasAPI.priceStats property
+
+The [SearchXModule](./x-components.searchxmodule.md) price specific stats.
+
+**Signature:**
+
+```typescript
+readonly priceStats: {
+        min: number;
+        max: number;
+    };
+```

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

@@ -9,15 +9,15 @@
 **Signature:**
 
 ```typescript
-export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents 
+export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents, RelatedPromptsXEvents 
 ```
-**Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)
+**Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)<!-- -->, [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)
 
 ## Remarks
 
 Aside from common events, this interface also extends the different XModule's XEventsTypes. If you arrived here from eDocs portal, please find the event you are looking for in the specific module. In the following links you will find the events that are special for each module:
 
-[DeviceXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/device/events.types.ts) [EmpathizeXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/empathize/events.types.ts) [FacetsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/facets/events.types.ts) [HistoryQueriesXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/history-queries/events.types.ts) [IdentifierResultsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/identifier-results/events.types.ts) [NextQueriesXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/next-queries/events.types.ts) [PopularSearchesXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/popular-searches/events.types.ts) [QueriesPreviewXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/queries-preview/events.types.ts) [QuerySuggestionsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/query-suggestions/events.types.ts) [RecommendationsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/recommendations/events.types.ts) [RelatedTagsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/related-tags/events.types.ts) [ScrollXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/scroll/events.types.ts) [SearchBoxXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/search-box/events.types.ts) [SearchXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/search/events.types.ts) [TaggingXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/tagging/events.types.ts) [UrlXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/url/events.types.ts)
+[DeviceXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/device/events.types.ts) [EmpathizeXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/empathize/events.types.ts) [FacetsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/facets/events.types.ts) [HistoryQueriesXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/history-queries/events.types.ts) [IdentifierResultsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/identifier-results/events.types.ts) [NextQueriesXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/next-queries/events.types.ts) [PopularSearchesXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/popular-searches/events.types.ts) [QueriesPreviewXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/queries-preview/events.types.ts) [QuerySuggestionsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/query-suggestions/events.types.ts) [RecommendationsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/recommendations/events.types.ts) [RelatedTagsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/related-tags/events.types.ts) [ScrollXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/scroll/events.types.ts) [SearchBoxXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/search-box/events.types.ts) [SearchXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/search/events.types.ts) [TaggingXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/tagging/events.types.ts) [UrlXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/url/events.types.ts) [RelatedPromptsXEvents](https://github.com/empathyco/x/blob/main/packages/x-components/src/x-modules/related-prompts/events.types.ts)
 
 ## Properties
 

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

@@ -28,6 +28,7 @@ export interface XModulesTree
 |  [queriesPreview](./x-components.xmodulestree.queriespreview.md) |  | [QueriesPreviewXModule](./x-components.queriespreviewxmodule.md) |  |
 |  [querySuggestions](./x-components.xmodulestree.querysuggestions.md) |  | [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) |  |
 |  [recommendations](./x-components.xmodulestree.recommendations.md) |  | [RecommendationsXModule](./x-components.recommendationsxmodule.md) |  |
+|  [relatedPrompts](./x-components.xmodulestree.relatedprompts.md) |  | [RelatedPromptsXModule](./x-components.relatedpromptsxmodule.md) |  |
 |  [relatedTags](./x-components.xmodulestree.relatedtags.md) |  | [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) |  |
 |  [scroll](./x-components.xmodulestree.scroll.md) |  | [ScrollXModule](./x-components.scrollxmodule.md) |  |
 |  [search](./x-components.xmodulestree.search.md) |  | [SearchXModule](./x-components.searchxmodule.md) |  |

package/docs/API-reference/api/x-components.xmodulestree.relatedprompts.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; [XModulesTree](./x-components.xmodulestree.md) &gt; [relatedPrompts](./x-components.xmodulestree.relatedprompts.md)
+
+## XModulesTree.relatedPrompts property
+
+**Signature:**
+
+```typescript
+relatedPrompts: RelatedPromptsXModule;
+```

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

@@ -69,6 +69,9 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [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. |
+|  [RelatedPrompt](./x-types.relatedprompt.md) | Represents a related prompt. |
+|  [RelatedPromptsRequest](./x-types.relatedpromptsrequest.md) | Request for Related Prompts endpoint. |
+|  [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md) | Response for the related prompts endpoint. |
 |  [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. |
@@ -85,6 +88,7 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [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. |
+|  [Stats](./x-types.stats.md) | <p>Statistics for the current search results.</p><p>Price - interval of the prices of the results.</p> |
 |  [Suggestion](./x-types.suggestion.md) | A suggestion represents a query that has been proposed to the user, due of being popular, matching with the current search query... |
 |  [Taggable](./x-types.taggable.md) | A taggable entity. |
 |  [Tagging](./x-types.tagging.md) | The tagging user actions. |

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md)
+
+## RelatedPrompt interface
+
+Represents a related prompt.
+
+**Signature:**
+
+```typescript
+export interface RelatedPrompt extends NamedModel<'RelatedPrompt'> 
+```
+**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- -->&lt;'RelatedPrompt'&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [nextQueries](./x-types.relatedprompt.nextqueries.md) |  | string\[\] | The next queries related to the prompt. |
+|  [suggestionText](./x-types.relatedprompt.suggestiontext.md) |  | string | The prompt. |
+|  [type](./x-types.relatedprompt.type.md) |  | string | The type of the prompt. |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [nextQueries](./x-types.relatedprompt.nextqueries.md)
+
+## RelatedPrompt.nextQueries property
+
+The next queries related to the prompt.
+
+**Signature:**
+
+```typescript
+nextQueries: string[];
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [suggestionText](./x-types.relatedprompt.suggestiontext.md)
+
+## RelatedPrompt.suggestionText property
+
+The prompt.
+
+**Signature:**
+
+```typescript
+suggestionText: string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [type](./x-types.relatedprompt.type.md)
+
+## RelatedPrompt.type property
+
+The type of the prompt.
+
+**Signature:**
+
+```typescript
+type: string;
+```