@empathyco/x-components 6.0.0-alpha.36 → 6.0.0-alpha.38

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

@@ -40,8 +40,10 @@
 |  [PlatformRecommendationsResponse](./x-adapter-platform.platformrecommendationsresponse.md) | Response for the <code>recommendations</code> endpoint. |
 |  [PlatformRedirection](./x-adapter-platform.platformredirection.md) | Redirection model for the <code>platform</code> API. |
 |  [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md) | Related prompt model for the <code>platform</code> API. |
+|  [PlatformRelatedPromptNextQueriesTagging](./x-adapter-platform.platformrelatedpromptnextqueriestagging.md) | Related prompt model for the <code>platform</code> API. |
 |  [PlatformRelatedPromptsRequest](./x-adapter-platform.platformrelatedpromptsrequest.md) | Request for the <code>related prompts</code> endpoint with <code>extra params</code>. |
 |  [PlatformRelatedPromptsResponse](./x-adapter-platform.platformrelatedpromptsresponse.md) | Response for the <code>related prompts</code> endpoint. |
+|  [PlatformRelatedPromptTagging](./x-adapter-platform.platformrelatedprompttagging.md) | Related prompt model for the <code>platform</code> API. |
 |  [PlatformRelatedTag](./x-adapter-platform.platformrelatedtag.md) | Related tag model for the <code>platform</code> API. |
 |  [PlatformRelatedTagsRequest](./x-adapter-platform.platformrelatedtagsrequest.md) | Request for the <code>related tags</code> endpoint with <code>extra params</code>. |
 |  [PlatformRelatedTagsResponse](./x-adapter-platform.platformrelatedtagsresponse.md) | Response for the <code>related tags</code> endpoint. |
@@ -72,6 +74,7 @@
 |  [identifierResultsResponseMapper](./x-adapter-platform.identifierresultsresponsemapper.md) | Default implementation for the IdentifierResultsResponseMapper. |
 |  [identifierResultsResponseSchema](./x-adapter-platform.identifierresultsresponseschema.md) | Default implementation for the IdentifierResultsResponseSchema. |
 |  [nextQueriesEndpointAdapter](./x-adapter-platform.nextqueriesendpointadapter.md) | This endpoint does not support pagination in the request. |
+|  [nextQueriesRelatedPromptsSchema](./x-adapter-platform.nextqueriesrelatedpromptsschema.md) |  |
 |  [nextQueriesRequestMapper](./x-adapter-platform.nextqueriesrequestmapper.md) | Default implementation for the NextQueriesRequestMapper. |
 |  [nextQueriesRequestSchema](./x-adapter-platform.nextqueriesrequestschema.md) | Default implementation for the NextQueriesRequestSchema. |
 |  [nextQueriesResponseMapper](./x-adapter-platform.nextqueriesresponsemapper.md) | Default implementation for the NextQueriesResponseMapper. |

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [nextQueriesRelatedPromptsSchema](./x-adapter-platform.nextqueriesrelatedpromptsschema.md)
+
+## nextQueriesRelatedPromptsSchema variable
+
+**Signature:**
+
+```typescript
+nextQueriesRelatedPromptsSchema: import("@empathyco/x-adapter").MutableSchema<string, RelatedPromptNextQuery>
+```

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

@@ -18,5 +18,6 @@ export interface PlatformRelatedPrompt
 |  --- | --- | --- | --- |
 |  [nextQueries](./x-adapter-platform.platformrelatedprompt.nextqueries.md) |  | string\[\] |  |
 |  [suggestionText](./x-adapter-platform.platformrelatedprompt.suggestiontext.md) |  | string |  |
+|  [tagging](./x-adapter-platform.platformrelatedprompt.tagging.md) |  | [PlatformRelatedPromptTagging](./x-adapter-platform.platformrelatedprompttagging.md) |  |
 |  [type](./x-adapter-platform.platformrelatedprompt.type.md) |  | 'SYNTHETIC' \| 'CURATED' |  |
 

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md) &gt; [tagging](./x-adapter-platform.platformrelatedprompt.tagging.md)
+
+## PlatformRelatedPrompt.tagging property
+
+**Signature:**
+
+```typescript
+tagging: PlatformRelatedPromptTagging;
+```

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptNextQueriesTagging](./x-adapter-platform.platformrelatedpromptnextqueriestagging.md)
+
+## PlatformRelatedPromptNextQueriesTagging interface
+
+Related prompt model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformRelatedPromptNextQueriesTagging 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [toolingDisplay](./x-adapter-platform.platformrelatedpromptnextqueriestagging.toolingdisplay.md) |  | string |  |
+|  [toolingDisplayAdd2Cart](./x-adapter-platform.platformrelatedpromptnextqueriestagging.toolingdisplayadd2cart.md) |  | string |  |
+|  [toolingDisplayClick](./x-adapter-platform.platformrelatedpromptnextqueriestagging.toolingdisplayclick.md) |  | string |  |
+

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptNextQueriesTagging](./x-adapter-platform.platformrelatedpromptnextqueriestagging.md) &gt; [toolingDisplay](./x-adapter-platform.platformrelatedpromptnextqueriestagging.toolingdisplay.md)
+
+## PlatformRelatedPromptNextQueriesTagging.toolingDisplay property
+
+**Signature:**
+
+```typescript
+toolingDisplay: string;
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptNextQueriesTagging](./x-adapter-platform.platformrelatedpromptnextqueriestagging.md) &gt; [toolingDisplayAdd2Cart](./x-adapter-platform.platformrelatedpromptnextqueriestagging.toolingdisplayadd2cart.md)
+
+## PlatformRelatedPromptNextQueriesTagging.toolingDisplayAdd2Cart property
+
+**Signature:**
+
+```typescript
+toolingDisplayAdd2Cart: string;
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptNextQueriesTagging](./x-adapter-platform.platformrelatedpromptnextqueriestagging.md) &gt; [toolingDisplayClick](./x-adapter-platform.platformrelatedpromptnextqueriestagging.toolingdisplayclick.md)
+
+## PlatformRelatedPromptNextQueriesTagging.toolingDisplayClick property
+
+**Signature:**
+
+```typescript
+toolingDisplayClick: string;
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptTagging](./x-adapter-platform.platformrelatedprompttagging.md)
+
+## PlatformRelatedPromptTagging interface
+
+Related prompt model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformRelatedPromptTagging 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [nextQueries](./x-adapter-platform.platformrelatedprompttagging.nextqueries.md) |  | Dictionary&lt;[PlatformRelatedPromptNextQueriesTagging](./x-adapter-platform.platformrelatedpromptnextqueriestagging.md)<!-- -->&gt; |  |
+|  [toolingDisplay](./x-adapter-platform.platformrelatedprompttagging.toolingdisplay.md) |  | string |  |
+

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptTagging](./x-adapter-platform.platformrelatedprompttagging.md) &gt; [nextQueries](./x-adapter-platform.platformrelatedprompttagging.nextqueries.md)
+
+## PlatformRelatedPromptTagging.nextQueries property
+
+**Signature:**
+
+```typescript
+nextQueries: Dictionary<PlatformRelatedPromptNextQueriesTagging>;
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptTagging](./x-adapter-platform.platformrelatedprompttagging.md) &gt; [toolingDisplay](./x-adapter-platform.platformrelatedprompttagging.toolingdisplay.md)
+
+## PlatformRelatedPromptTagging.toolingDisplay property
+
+**Signature:**
+
+```typescript
+toolingDisplay: string;
+```

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

@@ -16,6 +16,7 @@ _default: import("vue").DefineComponent<{
     };
 }, {
     events: import("vue").ComputedRef<Partial<XEventsTypes>>;
+    metadata: Omit<WireMetadata, "moduleName" | "origin" | "location">;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     result: {
         type: PropType<Result>;

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [createTrackToolingAdd2CartWire](./x-components.createtracktoolingadd2cartwire.md)
+
+## createTrackToolingAdd2CartWire() function
+
+Factory helper to create a wire for the track of the tooling display click.
+
+**Signature:**
+
+```typescript
+export declare function createTrackToolingAdd2CartWire(): Wire<Taggable>;
+```
+**Returns:**
+
+[Wire](./x-components.wire.md)<!-- -->&lt;Taggable&gt;
+
+A new wire for the tooling display add to cart of the taggable element.
+

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [createTrackToolingDisplayWire](./x-components.createtracktoolingdisplaywire.md)
+
+## createTrackToolingDisplayWire() function
+
+Factory helper to create a wire for the track of the tooling display click.
+
+**Signature:**
+
+```typescript
+export declare function createTrackToolingDisplayWire(): Wire<Taggable>;
+```
+**Returns:**
+
+[Wire](./x-components.wire.md)<!-- -->&lt;Taggable&gt;
+
+A new wire for the tooling display click of the taggable element.
+

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

@@ -9,7 +9,7 @@ Indicates where the feature is placed.
 **Signature:**
 
 ```typescript
-export type FeatureLocation = 'external' | 'my_history' | 'no_query' | 'results' | 'no_results' | 'low_results' | 'none' | 'predictive_layer' | 'pdp' | 'url_history' | 'url_history_pdp';
+export type FeatureLocation = 'external' | 'my_history' | 'no_query' | 'results' | 'no_results' | 'low_results' | 'none' | 'predictive_layer' | 'pdp' | 'url_history' | 'url_history_pdp' | 'related-prompts';
 ```
 
 ## Example 1

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

@@ -175,6 +175,8 @@ _default: import("vue").DefineComponent<{
             RelatedPromptsRequestUpdated: (payload: import("@empathyco/x-types").RelatedPromptsRequest | null, metadata: import("..").WireMetadata) => unknown;
             UserSelectedARelatedPrompt: (payload: number, metadata: import("..").WireMetadata) => unknown;
             UserSelectedARelatedPromptQuery: (payload: number, metadata: import("..").WireMetadata) => unknown;
+            UserClickedARelatedPromptResult: (payload: import("@empathyco/x-types").Result, metadata: import("..").WireMetadata) => unknown;
+            UserClickedARelatedPromptAdd2Cart: (payload: import("@empathyco/x-types").Result, metadata: import("..").WireMetadata) => unknown;
         }>>;
         required: true;
     };
@@ -344,6 +346,8 @@ _default: import("vue").DefineComponent<{
             RelatedPromptsRequestUpdated: (payload: import("@empathyco/x-types").RelatedPromptsRequest | null, metadata: import("..").WireMetadata) => unknown;
             UserSelectedARelatedPrompt: (payload: number, metadata: import("..").WireMetadata) => unknown;
             UserSelectedARelatedPromptQuery: (payload: number, metadata: import("..").WireMetadata) => unknown;
+            UserClickedARelatedPromptResult: (payload: import("@empathyco/x-types").Result, metadata: import("..").WireMetadata) => unknown;
+            UserClickedARelatedPromptAdd2Cart: (payload: import("@empathyco/x-types").Result, metadata: import("..").WireMetadata) => unknown;
         }>>;
         required: true;
     };

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

@@ -187,6 +187,8 @@ _default: import("vue").DefineComponent<{
         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>)[]>;
     renderedChildrenFilters: import("vue").ComputedRef<HierarchicalFilterModel[]>;

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

@@ -36,6 +36,8 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [createSetQueryTaggingFromQueryPreview()](./x-components.createsetquerytaggingfromquerypreview.md) | Factory helper to create a wire to set the queryTagging. |
 |  [createStoreEmitters(storeModule, emitters)](./x-components.createstoreemitters.md) | Helper function for creating type-safe [StoreEmitters](./x-components.storeemitters.md)<!-- -->. |
 |  [createTrackDisplayWire(property)](./x-components.createtrackdisplaywire.md) | Factory helper to create a wire for the track of the display click. |
+|  [createTrackToolingAdd2CartWire()](./x-components.createtracktoolingadd2cartwire.md) | Factory helper to create a wire for the track of the tooling display click. |
+|  [createTrackToolingDisplayWire()](./x-components.createtracktoolingdisplaywire.md) | Factory helper to create a wire for the track of the tooling display click. |
 |  [createTrackWire(property)](./x-components.createtrackwire.md) | Factory helper to create a wire for the track of a taggable element. |
 |  [createUseDevice(devices)](./x-components.createusedevice.md) | Factory function that creates a composable for device detection using the devices parameter to configure breakpoints. |
 |  [createWireFromFunction(fn)](./x-components.createwirefromfunction.md) | Creates a wire that executes the function passed. This function will receive a [WireParams](./x-components.wireparams.md) object. |
@@ -250,6 +252,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [TaggingXEvents](./x-components.taggingxevents.md) | Dictionary of the events of Tagging XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
 |  [ThrottleFunction](./x-components.throttlefunction.md) | The type returned by the [throttle()](./x-components.throttle.md) function. Basically is the function the [throttle()](./x-components.throttle.md) receives but throttled. |
 |  [TimedWireOperatorOptions](./x-components.timedwireoperatoroptions.md) | Options for wire operators that delay subscribers. |
+|  [TypingOptions](./x-components.typingoptions.md) | TypingOptions interface. |
 |  [UrlActions](./x-components.urlactions.md) | URL store actions. |
 |  [UrlGetters](./x-components.urlgetters.md) | URL store getters. |
 |  [UrlMutations](./x-components.urlmutations.md) | URL store mutations. |
@@ -485,10 +488,10 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [Redirection](./x-components.redirection.md) | A redirection is a component that sends the user to a link in the website. It is helpful when there are queries like <code>help</code>, <code>shipping costs</code>, <code>my account</code>, where a link to a section in the website will be more helpful than the set of results returned. |
 |  [refreshHistoryQueriesSession](./x-components.refreshhistoryqueriessession.md) | Triggers a session refresh, extending its validity for the time configured in the [HistoryQueriesConfig.sessionTTLInMs](./x-components.historyqueriesconfig.sessionttlinms.md)<!-- -->. |
 |  [refreshSession](./x-components.refreshsession.md) | Default implementation for the [HistoryQueriesActions.refreshSession()](./x-components.historyqueriesactions.refreshsession.md)<!-- -->. |
-|  [RelatedPrompt](./x-components.relatedprompt.md) | <p>This component shows a suggested related prompt.</p><p>It provides a slot to customize the related prompt button information.</p> |
+|  [RelatedPrompt](./x-components.relatedprompt.md) | This component shows a suggested related prompt. |
 |  [relatedPromptRequest](./x-components.relatedpromptrequest.md) | Default implementation for the [RelatedPromptsGetters.request](./x-components.relatedpromptsgetters.request.md) getter. |
 |  [RelatedPromptsList](./x-components.relatedpromptslist.md) | Component that inserts groups of related prompts in different positions of the injected search items list, based on the provided configuration. |
-|  [RelatedPromptsTagList](./x-components.relatedpromptstaglist.md) |  |
+|  [RelatedPromptsTagList](./x-components.relatedpromptstaglist.md) | <p>This component shows the list of <code>RelatedPrompts</code> components.</p><p>If the default slot is reimplemented in the consumer, <code>onSelect</code> function will be necessary to handle the selection of the related prompt and to trigger the stagger-fade-slide animation.</p> |
 |  [relatedPromptsXModule](./x-components.relatedpromptsxmodule.md) | Related Prompts [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>related-prompts</code> entry point. |
 |  [RelatedTag](./x-components.relatedtag.md) | This component renders a related tag for a query. A related tag is a descriptive keyword related to the current query to fine-tune the search. For example, if you are searching for \*lego\*, a related tag could be \*city\*, refining the search with \*lego city\*. |
 |  [relatedTags](./x-components.relatedtags.md) | Default implementation for the [RelatedTagsGetters.relatedTags](./x-components.relatedtagsgetters.relatedtags.md) getter. |
@@ -644,6 +647,8 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [trackNoResultsQueryWithSemanticsWireDebounced](./x-components.tracknoresultsquerywithsemanticswiredebounced.md) | . Debounced version of [trackNoResultsQueryWithSemanticsWire](./x-components.tracknoresultsquerywithsemanticswire.md) |
 |  [trackQueryWire](./x-components.trackquerywire.md) | Tracks the tagging of the query. |
 |  [trackResultClickedWire](./x-components.trackresultclickedwire.md) | Tracks the tagging of the result. |
+|  [trackToolingAdd2CartWire](./x-components.tracktoolingadd2cartwire.md) | Performs a track of a display result being clicked. |
+|  [trackToolingDisplayClickedWire](./x-components.tracktoolingdisplayclickedwire.md) | Performs a track of a display result being clicked. |
 |  [updateHistoryQueriesWithSearchResponse](./x-components.updatehistoryquerieswithsearchresponse.md) | Updates the history queries with the relevant info included in a search response. |
 |  [UrlHandler](./x-components.urlhandler.md) | This component manages the browser URL parameters to preserve them through reloads and browser history navigation. It allow to configure the default url parameter names using its attributes. This component doesn't render elements to the DOM. |
 |  [urlXModule](./x-components.urlxmodule.md) | URL [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>url</code> entry point. |

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

@@ -9,5 +9,5 @@ The name of the tool that generated the query.
 **Signature:**
 
 ```typescript
-export type QueryFeature = 'search_box' | 'url' | 'query_suggestion' | 'next_query' | 'popular_search' | 'history_query' | 'partial_result' | 'related_tag' | 'spellcheck' | 'customer' | 'semantics';
+export type QueryFeature = 'search_box' | 'url' | 'query_suggestion' | 'next_query' | 'popular_search' | 'history_query' | 'partial_result' | 'related_tag' | 'spellcheck' | 'customer' | 'semantics' | 'related-prompts';
 ```

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

@@ -6,8 +6,6 @@
 
 This component shows a suggested related prompt.
 
-It provides a slot to customize the related prompt button information.
-
 **Signature:**
 
 ```typescript
@@ -16,39 +14,20 @@ _default: import("vue").DefineComponent<{
         type: PropType<RelatedPrompt>;
         required: true;
     };
-    isPromptVisible: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    isSelected: {
+    selected: {
         type: BooleanConstructor;
         default: boolean;
     };
-    index: {
-        type: NumberConstructor;
-        required: true;
-    };
-}, {
-    toggleSuggestion: (index: number) => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     relatedPrompt: {
         type: PropType<RelatedPrompt>;
         required: true;
     };
-    isPromptVisible: {
+    selected: {
         type: BooleanConstructor;
         default: boolean;
     };
-    isSelected: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    index: {
-        type: NumberConstructor;
-        required: true;
-    };
 }>>, {
-    isPromptVisible: boolean;
-    isSelected: boolean;
+    selected: boolean;
 }, {}>
 ```

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

@@ -4,19 +4,53 @@
 
 ## RelatedPromptsTagList variable
 
+This component shows the list of `RelatedPrompts` components.
+
+If the default slot is reimplemented in the consumer, `onSelect` function will be necessary to handle the selection of the related prompt and to trigger the stagger-fade-slide animation.
+
 **Signature:**
 
 ```typescript
 _default: import("vue").DefineComponent<{
     buttonClass: StringConstructor;
+    tagClass: StringConstructor;
+    tagColors: PropType<string[]>;
+    animationDurationInMs: {
+        type: NumberConstructor;
+        default: number;
+    };
 }, {
-    arePromptsVisible: import("vue").Ref<boolean>;
-    hidePrompt: (index: number) => boolean;
     isSelected: (index: number) => boolean;
-    relatedPrompts: import("vue").ComputedRef<any>;
-    selectedPrompt: import("vue").ComputedRef<any>;
-    slidingPanelContent: import("vue").Ref<Element | undefined>;
+    onSelect: (selectedIndex: number) => void;
+    onBeforeEnter: (el: Element) => void;
+    onEnter: (el: Element, done: () => void) => void;
+    onLeave: (el: Element, done: () => void) => void;
+    selectedPromptIndex: import("vue").ComputedRef<any>;
+    visibleRelatedPrompts: import("vue").ComputedRef<{
+        index: number;
+        relatedPromptNextQueries: import("@empathyco/x-types").RelatedPromptNextQuery[];
+        suggestionText: string;
+        type: string;
+        toolingDisplayTagging: import("@empathyco/x-types").TaggingRequest;
+        modelName: "RelatedPrompt";
+    }[]>;
+    listItems: import("vue").Ref<HTMLElement[]>;
+    isAnimating: import("vue").Ref<boolean>;
+    x: import("../../../composables").UseAliasAPI & {
+        on: <Event_1 extends keyof import("../../..").XEventsTypes, Metadata extends boolean>(event: Event_1, withMetadata: Metadata) => {
+            subscribe: (callback: (payload: Metadata extends true ? import("@empathyco/x-bus").SubjectPayload<import("@empathyco/x-bus").EventPayload<import("../../..").XEventsTypes, Event_1>, import("../../..").WireMetadata> : import("@empathyco/x-bus").EventPayload<import("../../..").XEventsTypes, Event_1>) => void) => void;
+        };
+        emit: <Event_2 extends keyof import("../../..").XEventsTypes>(event: Event_2, payload?: import("../../..").XEventPayload<Event_2> | undefined, metadata?: Omit<import("../../..").WireMetadata, "moduleName">) => Promise<import("@empathyco/x-bus").EmittedData<import("../../..").XEventsTypes, Event_2, import("../../..").WireMetadata>>;
+    };
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     buttonClass: StringConstructor;
-}>>, {}, {}>
+    tagClass: StringConstructor;
+    tagColors: PropType<string[]>;
+    animationDurationInMs: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>>, {
+    animationDurationInMs: number;
+}, {}>
 ```

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

@@ -17,6 +17,8 @@ export interface RelatedPromptsXEvents
 |  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. |
+|  [UserClickedARelatedPromptAdd2Cart](./x-components.relatedpromptsxevents.userclickedarelatedpromptadd2cart.md) |  | Result | The user has clicked one add to cart from a prompt. Payload: The result that the user clicked. |
+|  [UserClickedARelatedPromptResult](./x-components.relatedpromptsxevents.userclickedarelatedpromptresult.md) |  | Result | The user has clicked one prompt. Payload: The result that the user clicked. |
 |  [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.userclickedarelatedpromptadd2cart.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; [UserClickedARelatedPromptAdd2Cart](./x-components.relatedpromptsxevents.userclickedarelatedpromptadd2cart.md)
+
+## RelatedPromptsXEvents.UserClickedARelatedPromptAdd2Cart property
+
+The user has clicked one add to cart from a prompt. Payload: The result that the user clicked.
+
+**Signature:**
+
+```typescript
+UserClickedARelatedPromptAdd2Cart: Result;
+```

package/docs/API-reference/api/x-components.relatedpromptsxevents.userclickedarelatedpromptresult.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; [UserClickedARelatedPromptResult](./x-components.relatedpromptsxevents.userclickedarelatedpromptresult.md)
+
+## RelatedPromptsXEvents.UserClickedARelatedPromptResult property
+
+The user has clicked one prompt. Payload: The result that the user clicked.
+
+**Signature:**
+
+```typescript
+UserClickedARelatedPromptResult: Result;
+```

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

@@ -184,6 +184,8 @@ _default: import("vue").DefineComponent<{
         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.snippetcallbacks.md

@@ -174,6 +174,8 @@ _default: import("vue").DefineComponent<{}, {
         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.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.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-types.md

@@ -70,6 +70,7 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [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. |

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

@@ -17,7 +17,8 @@ export interface RelatedPrompt extends NamedModel<'RelatedPrompt'>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [nextQueries](./x-types.relatedprompt.nextqueries.md) |  | string\[\] | The next queries related to the prompt. |
+|  [relatedPromptNextQueries](./x-types.relatedprompt.relatedpromptnextqueries.md) |  | [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md)<!-- -->\[\] | The next queries related to the prompt. |
 |  [suggestionText](./x-types.relatedprompt.suggestiontext.md) |  | string | The prompt. |
+|  [toolingDisplayTagging](./x-types.relatedprompt.toolingdisplaytagging.md) |  | [TaggingRequest](./x-types.taggingrequest.md) | 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.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[];
+```