@empathyco/x-components 6.0.0-alpha.5 → 6.0.0-alpha.51

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [setConfig](./x-components.setconfig.md)
+
+## setConfig() function
+
+Sets the request config. Can be used as a mutation.
+
+**Signature:**
+
+```typescript
+export declare function setConfig<T extends {
+    config: T['config'];
+}>(state: T, config: T['config']): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  state | T | The [state](https://vuex.vuejs.org/guide/state.html) provided by Vuex. |
+|  config | T\['config'\] | The new config. |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [setQuery](./x-components.setquery.md)
+
+## setQuery() function
+
+Sets the query of the module.
+
+**Signature:**
+
+```typescript
+export declare function setQuery(state: QueryState, query: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  state | [QueryState](./x-components.querystate.md) | State of the module. |
+|  query | string | The new query to set. |
+
+**Returns:**
+
+void
+

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

@@ -163,6 +163,7 @@ _default: import("vue").DefineComponent<{
         UserClickedAPromoted?: import("@empathyco/x-types").Promoted | undefined;
         UserClickedABanner?: import("@empathyco/x-types").Banner | undefined;
         UserClickedAbortARedirection?: void | undefined;
+        UserSelectedAPage?: number | undefined;
         SemanticQueryRequestUpdated?: import("@empathyco/x-types").SemanticQueriesRequest | null | undefined;
         SemanticQueriesResponseChanged?: import("@empathyco/x-types").SemanticQuery[] | undefined;
         UserSelectedASemanticQuery?: import("@empathyco/x-types").SemanticQuery | undefined;
@@ -180,6 +181,11 @@ _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;
+        UserClickedARelatedPromptResult?: import("@empathyco/x-types").Result | undefined;
+        UserClickedARelatedPromptAdd2Cart?: import("@empathyco/x-types").Result | 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.slidingpanel.md

@@ -24,14 +24,18 @@ _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-    buttonClass: StringConstructor;
-    scrollContainerClass: StringConstructor;
+    buttonClass: {
+        type: PropType<VueCSSClasses>;
+    };
+    scrollContainerClass: {
+        type: PropType<VueCSSClasses>;
+    };
 }, {
     cssClasses: import("vue").ComputedRef<{
         'x-sliding-panel-at-start': boolean;
         'x-sliding-panel-at-end': boolean;
     }>;
-    debouncedUpdateScroll: import("..").DebouncedFunction<[]>;
+    debouncedUpdateScroll: import("../utils/types").DebouncedFunction<[]>;
     scrollContainerRef: import("vue").Ref<HTMLDivElement | undefined>;
     scrollLeft: () => void;
     scrollRight: () => void;
@@ -51,8 +55,12 @@ _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-    buttonClass: StringConstructor;
-    scrollContainerClass: StringConstructor;
+    buttonClass: {
+        type: PropType<VueCSSClasses>;
+    };
+    scrollContainerClass: {
+        type: PropType<VueCSSClasses>;
+    };
 }>>, {
     scrollFactor: number;
     showButtons: boolean;

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

@@ -153,6 +153,7 @@ _default: import("vue").DefineComponent<{}, {
         UserClickedAPromoted: (payload: import("@empathyco/x-types").Promoted, metadata: WireMetadata) => unknown;
         UserClickedABanner: (payload: import("@empathyco/x-types").Banner, metadata: WireMetadata) => unknown;
         UserClickedAbortARedirection: (payload: undefined, metadata: WireMetadata) => unknown;
+        UserSelectedAPage: (payload: number, metadata: WireMetadata) => unknown;
         SemanticQueryRequestUpdated: (payload: import("@empathyco/x-types").SemanticQueriesRequest | null, metadata: WireMetadata) => unknown;
         SemanticQueriesResponseChanged: (payload: import("@empathyco/x-types").SemanticQuery[], metadata: WireMetadata) => unknown;
         UserSelectedASemanticQuery: (payload: import("@empathyco/x-types").SemanticQuery, metadata: WireMetadata) => unknown;
@@ -170,6 +171,11 @@ _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;
+        UserClickedARelatedPromptResult: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
+        UserClickedARelatedPromptAdd2Cart: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
     }>>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
 ```

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

@@ -10,11 +10,11 @@ This component enables and manages the sending of information to the \[Empathy T
 
 ```typescript
 _default: import("vue").DefineComponent<{
-    clickedResultStorageTTLMs: {
+    storageTTLMs: {
         type: NumberConstructor;
         default: number;
     };
-    clickedResultStorageKey: {
+    storageKey: {
         type: StringConstructor;
         default: string;
     };
@@ -28,11 +28,11 @@ _default: import("vue").DefineComponent<{
         default: null;
     };
 }, () => void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    clickedResultStorageTTLMs: {
+    storageTTLMs: {
         type: NumberConstructor;
         default: number;
     };
-    clickedResultStorageKey: {
+    storageKey: {
         type: StringConstructor;
         default: string;
     };
@@ -46,8 +46,8 @@ _default: import("vue").DefineComponent<{
         default: null;
     };
 }>>, {
-    clickedResultStorageTTLMs: number;
-    clickedResultStorageKey: string;
+    storageTTLMs: number;
+    storageKey: string;
     queryTaggingDebounceMs: number;
     consent: boolean;
 }, {}>

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

@@ -16,8 +16,8 @@ export interface TaggingConfig
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [clickedResultStorageKey](./x-components.taggingconfig.clickedresultstoragekey.md) |  | string \| null | Field of the [result](./x-types.result.md) to use as id for storing the information. |
-|  [clickedResultStorageTTLMs](./x-components.taggingconfig.clickedresultstoragettlms.md) |  | number \| null | Time in milliseconds to keep the information for a result clicked by the user. |
 |  [queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md) |  | number | Time in milliseconds to track the query. |
 |  [sessionTTLMs](./x-components.taggingconfig.sessionttlms.md) |  | number | Time in milliseconds to keep the session alive. After this time has passed with no user interaction, the session will be cleared. |
+|  [storageKey](./x-components.taggingconfig.storagekey.md) |  | string \| null | Field of the [result](./x-types.result.md) to use as id for storing the information. |
+|  [storageTTLMs](./x-components.taggingconfig.storagettlms.md) |  | number \| null | Time in milliseconds to keep the information for a result. |
 

package/docs/API-reference/api/{x-components.taggingconfig.clickedresultstoragekey.md → x-components.taggingconfig.storagekey.md}

@@ -1,13 +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; [TaggingConfig](./x-components.taggingconfig.md) &gt; [clickedResultStorageKey](./x-components.taggingconfig.clickedresultstoragekey.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TaggingConfig](./x-components.taggingconfig.md) &gt; [storageKey](./x-components.taggingconfig.storagekey.md)
 
-## TaggingConfig.clickedResultStorageKey property
+## TaggingConfig.storageKey property
 
 Field of the [result](./x-types.result.md) to use as id for storing the information.
 
 **Signature:**
 
 ```typescript
-clickedResultStorageKey: string | null;
+storageKey: string | null;
 ```

package/docs/API-reference/api/x-components.taggingconfig.storagettlms.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; [TaggingConfig](./x-components.taggingconfig.md) &gt; [storageTTLMs](./x-components.taggingconfig.storagettlms.md)
+
+## TaggingConfig.storageTTLMs property
+
+Time in milliseconds to keep the information for a result.
+
+**Signature:**
+
+```typescript
+storageTTLMs: number | null;
+```

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

@@ -11,7 +11,7 @@ Tagging store mutations.
 ```typescript
 export interface TaggingMutations extends ConfigMutations<TaggingState> 
 ```
-**Extends:** ConfigMutations&lt;[TaggingState](./x-components.taggingstate.md)<!-- -->&gt;
+**Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[TaggingState](./x-components.taggingstate.md)<!-- -->&gt;
 
 ## Methods
 

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

@@ -19,7 +19,7 @@ export interface TaggingXEvents
 |  [ConsentChanged](./x-components.taggingxevents.consentchanged.md) |  | boolean | Consent has changed. Payload: The new consent value. |
 |  [ConsentProvided](./x-components.taggingxevents.consentprovided.md) |  | boolean | Consent has been provided. Payload: The new consent value. |
 |  [PDPIsLoaded](./x-components.taggingxevents.pdpisloaded.md) |  | string | A product description page has been loaded. Payload: the id of the product. |
-|  [ResultURLTrackingEnabled](./x-components.taggingxevents.resulturltrackingenabled.md) |  | string | ClickedResultStorageKey has been configured to use the [result](./x-types.result.md) url. Payload: The new clickedResultStorageKey. |
+|  [ResultURLTrackingEnabled](./x-components.taggingxevents.resulturltrackingenabled.md) |  | string | StorageKey has been configured to use the [result](./x-types.result.md) url. Payload: The new storageKey. |
 |  [SearchTaggingReceived](./x-components.taggingxevents.searchtaggingreceived.md) |  | TaggingRequest | Query tagging info has changed. Payload: The new query tagging info. |
 |  [TaggingConfigProvided](./x-components.taggingxevents.taggingconfigprovided.md) |  | [TaggingConfig](./x-components.taggingconfig.md) | The configuration for the tagging has been provided. Payload: The tagging configuration. |
 |  [TrackableElementDisplayed](./x-components.taggingxevents.trackableelementdisplayed.md) |  | Taggable | Display trackable element has appeared in the viewport. Payload: The display tagging info. |

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

@@ -4,7 +4,7 @@
 
 ## TaggingXEvents.ResultURLTrackingEnabled property
 
-ClickedResultStorageKey has been configured to use the [result](./x-types.result.md) url. Payload: The new clickedResultStorageKey.
+StorageKey has been configured to use the [result](./x-types.result.md) url. Payload: The new storageKey.
 
 **Signature:**
 

package/docs/API-reference/api/x-components.trackrelatedprompttoolingdisplayclickwire.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; [trackRelatedPromptToolingDisplayClickWire](./x-components.trackrelatedprompttoolingdisplayclickwire.md)
+
+## trackRelatedPromptToolingDisplayClickWire variable
+
+Performs a track of a clicked related prompt.
+
+**Signature:**
+
+```typescript
+trackRelatedPromptToolingDisplayClickWire: Wire<any>
+```

package/docs/API-reference/api/x-components.tracktoolingadd2cartwire.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; [trackToolingAdd2CartWire](./x-components.tracktoolingadd2cartwire.md)
+
+## trackToolingAdd2CartWire variable
+
+Performs a track of a display result being clicked.
+
+**Signature:**
+
+```typescript
+trackToolingAdd2CartWire: Wire<Taggable>
+```

package/docs/API-reference/api/x-components.tracktoolingdisplayclickedwire.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; [trackToolingDisplayClickedWire](./x-components.tracktoolingdisplayclickedwire.md)
+
+## trackToolingDisplayClickedWire variable
+
+Performs a track of a display result being clicked.
+
+**Signature:**
+
+```typescript
+trackToolingDisplayClickedWire: Wire<Taggable>
+```

package/docs/API-reference/api/x-components.typing.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; [typing](./x-components.typing.md)
+
+## typing variable
+
+Typing directive.
+
+**Signature:**
+
+```typescript
+typing: Directive<TypingHTMLElement, TypingOptions>
+```

package/docs/API-reference/api/x-components.typingoptions.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; [TypingOptions](./x-components.typingoptions.md)
+
+## TypingOptions interface
+
+TypingOptions interface.
+
+**Signature:**
+
+```typescript
+export interface TypingOptions 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [speed?](./x-components.typingoptions.speed.md) |  | number | _(Optional)_ The typing speed in milliseconds per character. |
+|  [targetAttr?](./x-components.typingoptions.targetattr.md) |  | string | _(Optional)_ The attribute of the HTML element where the typed text will be placed. If not specified, the text will be set as content (innerHTML). |
+|  [text](./x-components.typingoptions.text.md) |  | string | The text (plain or html) that will be typed into the target element. |
+

package/docs/API-reference/api/x-components.typingoptions.speed.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; [TypingOptions](./x-components.typingoptions.md) &gt; [speed](./x-components.typingoptions.speed.md)
+
+## TypingOptions.speed property
+
+The typing speed in milliseconds per character.
+
+**Signature:**
+
+```typescript
+speed?: number;
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TypingOptions](./x-components.typingoptions.md) &gt; [targetAttr](./x-components.typingoptions.targetattr.md)
+
+## TypingOptions.targetAttr property
+
+The attribute of the HTML element where the typed text will be placed. If not specified, the text will be set as content (innerHTML).
+
+**Signature:**
+
+```typescript
+targetAttr?: string;
+```
+
+## Example
+
+'placeholder'
+

package/docs/API-reference/api/x-components.typingoptions.text.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; [TypingOptions](./x-components.typingoptions.md) &gt; [text](./x-components.typingoptions.text.md)
+
+## TypingOptions.text property
+
+The text (plain or html) that will be typed into the target element.
+
+**Signature:**
+
+```typescript
+text: string;
+```

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

@@ -11,7 +11,7 @@ URL store mutations.
 ```typescript
 export interface UrlMutations extends QueryMutations 
 ```
-**Extends:** QueryMutations
+**Extends:** [QueryMutations](./x-components.querymutations.md)
 
 ## Methods
 

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

@@ -11,7 +11,7 @@ URL store state.
 ```typescript
 export interface UrlState extends QueryState, UrlParams 
 ```
-**Extends:** QueryState, [UrlParams](./x-components.urlparams.md)
+**Extends:** [QueryState](./x-components.querystate.md)<!-- -->, [UrlParams](./x-components.urlparams.md)
 
 ## Properties
 

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,10 @@ 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. |
+|  [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md) | Represents a related prompt nextQuery. |
+|  [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 +89,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,26 @@
+<!-- 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 queries of the next queries related to the prompt. |
+|  [relatedPromptNextQueries?](./x-types.relatedprompt.relatedpromptnextqueries.md) |  | [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md)<!-- -->\[\] | _(Optional)_ The next queries related to the prompt. |
+|  [suggestionText](./x-types.relatedprompt.suggestiontext.md) |  | string | The prompt. |
+|  [tagging?](./x-types.relatedprompt.tagging.md) |  | { toolingDisplayTagging?: [TaggingRequest](./x-types.taggingrequest.md)<!-- -->; toolingDisplayClickTagging?: [TaggingRequest](./x-types.taggingrequest.md)<!-- -->; nextQueriesTagging?: [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md)<!-- -->\[\]; } | _(Optional)_ Related prompt tagging. |
+|  [toolingDisplayTagging?](./x-types.relatedprompt.toolingdisplaytagging.md) |  | [TaggingRequest](./x-types.taggingrequest.md) | _(Optional)_ The tooling display tagging of 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 queries of the next queries related to the prompt.
+
+**Signature:**
+
+```typescript
+nextQueries: string[];
+```

package/docs/API-reference/api/x-types.relatedprompt.relatedpromptnextqueries.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; [relatedPromptNextQueries](./x-types.relatedprompt.relatedpromptnextqueries.md)
+
+## RelatedPrompt.relatedPromptNextQueries property
+
+The next queries related to the prompt.
+
+**Signature:**
+
+```typescript
+relatedPromptNextQueries?: RelatedPromptNextQuery[];
+```

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;
+```