npm - @empathyco/x-components - Versions diffs - 6.0.0-alpha.9 → 6.0.0-alpha.90 - Mend

@empathyco/x-components 6.0.0-alpha.9 → 6.0.0-alpha.90

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2736) hide show

package/docs/API-reference/api/x-components.useemitdisplayevent.md CHANGED Viewed

@@ -9,14 +9,14 @@ Composable that emits a `TrackableElementDisplayed` event whenever the provided
 **Signature:**
 ```typescript
-export declare function useEmitDisplayEvent({ element, taggingRequest, eventMetadata }: UseEmitDisplayEventOptions): UseOnDisplayReturn;
+export declare function useEmitDisplayEvent({ element, taggingRequest, eventMetadata, }: UseEmitDisplayEventOptions): UseOnDisplayReturn;
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { element, taggingRequest, eventMetadata } | UseEmitDisplayEventOptions |  |
+|  { element, taggingRequest, eventMetadata, } | UseEmitDisplayEventOptions |  |
 **Returns:**

package/docs/API-reference/api/x-components.usegetter.md CHANGED Viewed

@@ -2,26 +2,12 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [useGetter](./x-components.usegetter.md)
-## useGetter() function
+## useGetter variable
-Function which returns the requested getters as a dictionary of getters.
+Function which returns the requested getter's properties as a dictionary.
 **Signature:**
 ```typescript
-export declare function useGetter<Module extends XModuleName, GetterName extends keyof ExtractGetters<Module> & string>(module: Module, getters: GetterName[]): Dictionary<ComputedRef>;
+useGetter: UseGetter
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  module | Module | The [XModuleName](./x-components.xmodulename.md) of the getter. |
-|  getters | GetterName\[\] | List of getters names. |
-**Returns:**
-Dictionary&lt;ComputedRef&gt;
-The requested getters from the module.

package/docs/API-reference/api/x-components.useondisplay.md CHANGED Viewed

@@ -9,14 +9,14 @@ Composable that triggers a callback whenever the provided element appears in the
 **Signature:**
 ```typescript
-export declare function useOnDisplay({ element, callback, triggerOnce }: UseOnDisplayOptions): UseOnDisplayReturn;
+export declare function useOnDisplay({ element, callback, triggerOnce, }: UseOnDisplayOptions): UseOnDisplayReturn;
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { element, callback, triggerOnce } | UseOnDisplayOptions |  |
+|  { element, callback, triggerOnce, } | UseOnDisplayOptions |  |
 **Returns:**

package/docs/API-reference/api/x-components.usestate.md CHANGED Viewed

@@ -9,7 +9,9 @@ Function which returns the requested state's properties as a dictionary.
 **Signature:**
 ```typescript
-export declare function useState<Module extends XModuleName, Path extends keyof ExtractState<Module> & string>(module: Module, paths: Path[]): Dictionary<ComputedRef>;
+export declare function useState<Module extends XModuleName, State = ExtractState<Module>>(module: Module): {
+    [P in keyof State]: ComputedRef<State[P]>;
+};
 ```
 ## Parameters
@@ -17,11 +19,10 @@ export declare function useState<Module extends XModuleName, Path extends keyof
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  module | Module | The [XModuleName](./x-components.xmodulename.md) of the getter. |
-|  paths | Path\[\] | List of state paths. |
 **Returns:**
-Dictionary&lt;ComputedRef&gt;
+{ \[P in keyof State\]: ComputedRef&lt;State\[P\]&gt;; }
-The requested state properties of the module.
+A dictionary of computed state properties of the module.

package/docs/API-reference/api/x-components.xactioncontext.commit.md CHANGED Viewed

@@ -2,21 +2,10 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XActionContext](./x-components.xactioncontext.md) &gt; [commit](./x-components.xactioncontext.commit.md)
-## XActionContext.commit() method
+## XActionContext.commit property
 **Signature:**
 ```typescript
-commit<MutationName extends PropsWithType<Mutations, () => void>>(mutation: MutationName): void;
+commit: (<MutationName extends PropsWithType<Mutations, () => void>>(mutation: MutationName) => void) & (<MutationName extends keyof Mutations>(mutation: MutationName, payload: ExtractPayload<Mutations[MutationName]>) => void);
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  mutation | MutationName |  |
-**Returns:**
-void

package/docs/API-reference/api/x-components.xactioncontext.dispatch.md CHANGED Viewed

@@ -2,21 +2,10 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XActionContext](./x-components.xactioncontext.md) &gt; [dispatch](./x-components.xactioncontext.dispatch.md)
-## XActionContext.dispatch() method
+## XActionContext.dispatch property
 **Signature:**
 ```typescript
-dispatch<ActionName extends PropsWithType<Actions, () => any>>(action: ActionName): ExtractActionReturn<Actions[ActionName]>;
+dispatch: (<ActionName extends PropsWithType<Actions, () => any>>(action: ActionName) => ExtractActionReturn<Actions[ActionName]>) & (<ActionName extends keyof Actions>(action: ActionName, payload: ExtractPayload<Actions[ActionName]>) => ExtractActionReturn<Actions[ActionName]>);
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  action | ActionName |  |
-**Returns:**
-[ExtractActionReturn](./x-components.extractactionreturn.md)<!-- -->&lt;Actions\[ActionName\]&gt;

package/docs/API-reference/api/x-components.xactioncontext.md CHANGED Viewed

@@ -17,14 +17,7 @@ export interface XActionContext<State extends Dictionary, Getters extends Dictio
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [commit](./x-components.xactioncontext.commit.md) |  | (&lt;MutationName extends [PropsWithType](./x-components.propswithtype.md)<!-- -->&lt;Mutations, () =&gt; void&gt;&gt;(mutation: MutationName) =&gt; void) &amp; (&lt;MutationName extends keyof Mutations&gt;(mutation: MutationName, payload: [ExtractPayload](./x-components.extractpayload.md)<!-- -->&lt;Mutations\[MutationName\]&gt;) =&gt; void) |  |
+|  [dispatch](./x-components.xactioncontext.dispatch.md) |  | (&lt;ActionName extends [PropsWithType](./x-components.propswithtype.md)<!-- -->&lt;Actions, () =&gt; any&gt;&gt;(action: ActionName) =&gt; [ExtractActionReturn](./x-components.extractactionreturn.md)<!-- -->&lt;Actions\[ActionName\]&gt;) &amp; (&lt;ActionName extends keyof Actions&gt;(action: ActionName, payload: [ExtractPayload](./x-components.extractpayload.md)<!-- -->&lt;Actions\[ActionName\]&gt;) =&gt; [ExtractActionReturn](./x-components.extractactionreturn.md)<!-- -->&lt;Actions\[ActionName\]&gt;) |  |
 |  [getters](./x-components.xactioncontext.getters.md) |  | Getters |  |
-## Methods
-|  Method | Description |
-|  --- | --- |
-|  [commit(mutation)](./x-components.xactioncontext.commit.md) |  |
-|  [commit(mutation, payload)](./x-components.xactioncontext.commit_1.md) |  |
-|  [dispatch(action)](./x-components.xactioncontext.dispatch.md) |  |
-|  [dispatch(action, payload)](./x-components.xactioncontext.dispatch_1.md) |  |

package/docs/API-reference/api/x-components.xapi.addproducttocart.md CHANGED Viewed

@@ -2,26 +2,16 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XAPI](./x-components.xapi.md) &gt; [addProductToCart](./x-components.xapi.addproducttocart.md)
-## XAPI.addProductToCart() method
+## XAPI.addProductToCart property
 To track that a product was added to the cart from PDP.
 **Signature:**
 ```typescript
-addProductToCart(productId?: string): void;
+addProductToCart: (productId?: string) => void;
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  productId | string | _(Optional)_ The id of the product added to cart. |
-**Returns:**
-void
 ## Remarks
 if no productId is provided, then the current page url will be used as id for getting the previously stored result information.

package/docs/API-reference/api/x-components.xapi.getsnippetconfig.md CHANGED Viewed

@@ -2,18 +2,12 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XAPI](./x-components.xapi.md) &gt; [getSnippetConfig](./x-components.xapi.getsnippetconfig.md)
-## XAPI.getSnippetConfig() method
+## XAPI.getSnippetConfig property
 To get the snippet config object.
 **Signature:**
 ```typescript
-getSnippetConfig(): SnippetConfig;
+getSnippetConfig: () => SnippetConfig;
 ```
-**Returns:**
-[SnippetConfig](./x-components.snippetconfig.md)
-The [snippetConfig](./x-components.normalisedsnippetconfig.md) object.

package/docs/API-reference/api/x-components.xapi.init.md CHANGED Viewed

@@ -2,23 +2,12 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XAPI](./x-components.xapi.md) &gt; [init](./x-components.xapi.init.md)
-## XAPI.init() method
+## XAPI.init property
 Method to initialize the XComponents app.
 **Signature:**
 ```typescript
-init(config: SnippetConfig): Promise<void>;
+init: (config: SnippetConfig) => Promise<void>;
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  config | [SnippetConfig](./x-components.snippetconfig.md) | [SnippetConfig](./x-components.snippetconfig.md) To receive the customer parameters. |
-**Returns:**
-Promise&lt;void&gt;

package/docs/API-reference/api/x-components.xapi.md CHANGED Viewed

@@ -12,13 +12,13 @@ Interface with the API functions exposes as X [window](https://developer.mozilla
 export interface XAPI
 ```
-## Methods
-|  Method | Description |
-|  --- | --- |
-|  [addProductToCart(productId)](./x-components.xapi.addproducttocart.md) | To track that a product was added to the cart from PDP. |
-|  [getSnippetConfig()](./x-components.xapi.getsnippetconfig.md) | To get the snippet config object. |
-|  [init(config)](./x-components.xapi.init.md) | Method to initialize the XComponents app. |
-|  [search(query)](./x-components.xapi.search.md) | Dispatch a search with the query parameter. |
-|  [setSnippetConfig(config)](./x-components.xapi.setsnippetconfig.md) | To set or update any property of the [SnippetConfig](./x-components.snippetconfig.md)<!-- -->. |
+## Properties
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [addProductToCart](./x-components.xapi.addproducttocart.md) |  | (productId?: string) =&gt; void | To track that a product was added to the cart from PDP. |
+|  [getSnippetConfig](./x-components.xapi.getsnippetconfig.md) |  | () =&gt; [SnippetConfig](./x-components.snippetconfig.md) | To get the snippet config object. |
+|  [init](./x-components.xapi.init.md) |  | (config: [SnippetConfig](./x-components.snippetconfig.md)<!-- -->) =&gt; Promise&lt;void&gt; | Method to initialize the XComponents app. |
+|  [search](./x-components.xapi.search.md) |  | (query?: string) =&gt; void | Dispatch a search with the query parameter. |
+|  [setSnippetConfig](./x-components.xapi.setsnippetconfig.md) |  | (config: Partial&lt;[SnippetConfig](./x-components.snippetconfig.md)<!-- -->&gt;) =&gt; void | To set or update any property of the [SnippetConfig](./x-components.snippetconfig.md)<!-- -->. |

package/docs/API-reference/api/x-components.xapi.search.md CHANGED Viewed

@@ -2,23 +2,12 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XAPI](./x-components.xapi.md) &gt; [search](./x-components.xapi.search.md)
-## XAPI.search() method
+## XAPI.search property
 Dispatch a search with the query parameter.
 **Signature:**
 ```typescript
-search(query?: string): void;
+search: (query?: string) => void;
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  query | string | _(Optional)_ Query to be searched. |
-**Returns:**
-void

package/docs/API-reference/api/x-components.xapi.setsnippetconfig.md CHANGED Viewed

@@ -2,23 +2,12 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XAPI](./x-components.xapi.md) &gt; [setSnippetConfig](./x-components.xapi.setsnippetconfig.md)
-## XAPI.setSnippetConfig() method
+## XAPI.setSnippetConfig property
 To set or update any property of the [SnippetConfig](./x-components.snippetconfig.md)<!-- -->.
 **Signature:**
 ```typescript
-setSnippetConfig(config: Partial<SnippetConfig>): void;
+setSnippetConfig: (config: Partial<SnippetConfig>) => void;
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  config | Partial&lt;[SnippetConfig](./x-components.snippetconfig.md)<!-- -->&gt; | The properties to be changed. |
-**Returns:**
-void

package/docs/API-reference/api/x-components.xcomponentapi.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## XComponentAPI interface
-The XComponentAPI exposes access to the , and store aliases to the components.
+The XComponentAPI exposes access to the XBus, and store aliases to the components.
 **Signature:**

package/docs/API-reference/api/x-components.xcomponentbusapi.emit.md CHANGED Viewed

@@ -2,22 +2,11 @@
 [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XComponentBusAPI](./x-components.xcomponentbusapi.md) &gt; [emit](./x-components.xcomponentbusapi.emit.md)
-## XComponentBusAPI.emit() method
+## XComponentBusAPI.emit property
 **Signature:**
 ```typescript
-emit(event: PropsWithType<XEventsTypes, void>): void;
+emit: ((event: PropsWithType<XEventsTypes, void>) => void) & (<Event extends XEvent>(event: Event, payload: XEventPayload<Event>, metadata?: Omit<WireMetadata, 'moduleName' | 'origin' | 'location'>) => void);
 ```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  event | [PropsWithType](./x-components.propswithtype.md)<!-- -->&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, void&gt; |  |
-**Returns:**
-void

package/docs/API-reference/api/x-components.xcomponentbusapi.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## XComponentBusAPI interface
-API for emitting and subscribing to events of the .
+API for emitting and subscribing to events of the XBus.
 **Signature:**
@@ -16,12 +16,6 @@ export interface XComponentBusAPI
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [emit](./x-components.xcomponentbusapi.emit.md) |  | ((event: [PropsWithType](./x-components.propswithtype.md)<!-- -->&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, void&gt;) =&gt; void) &amp; (&lt;Event extends [XEvent](./x-components.xevent.md)<!-- -->&gt;(event: Event, payload: [XEventPayload](./x-components.xeventpayload.md)<!-- -->&lt;Event&gt;, metadata?: Omit&lt;[WireMetadata](./x-components.wiremetadata.md)<!-- -->, 'moduleName' \| 'origin' \| 'location'&gt;) =&gt; void) |  |
 |  [on](./x-components.xcomponentbusapi.on.md) |  | XBus&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, [WireMetadata](./x-components.wiremetadata.md)<!-- -->&gt;\['on'\] |  |
-## Methods
-|  Method | Description |
-|  --- | --- |
-|  [emit(event)](./x-components.xcomponentbusapi.emit.md) |  |
-|  [emit(event, payload, metadata)](./x-components.xcomponentbusapi.emit_1.md) |  |

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

@@ -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.xinstaller.init.md CHANGED Viewed

@@ -22,5 +22,5 @@ init(snippetConfig: SnippetConfig): Promise<InitWrapper>;
 Promise&lt;[InitWrapper](./x-components.initwrapper.md)<!-- -->&gt;
-If [snippet config](./x-components.snippetconfig.md) is passed or configured in window.initX, returns an object with the [XAPI](./x-components.xapi.md)<!-- -->, the , the [XPlugin](./x-components.xplugin.md) and the Vue application instance. Else, a rejected promise is returned.
+If [snippet config](./x-components.snippetconfig.md) is passed or configured in window.initX, returns an object with the [XAPI](./x-components.xapi.md)<!-- -->, the XBus, the [XPlugin](./x-components.xplugin.md) and the Vue application instance. Else, a rejected promise is returned.

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

@@ -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 ADDED Viewed

@@ -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-components.xplugin._constructor_.md CHANGED Viewed

@@ -16,5 +16,5 @@ constructor(bus: XBus<XEventsTypes, WireMetadata>);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  bus | XBus&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, [WireMetadata](./x-components.wiremetadata.md)<!-- -->&gt; | The  implementation to use for the plugin. |
+|  bus | XBus&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, [WireMetadata](./x-components.wiremetadata.md)<!-- -->&gt; | The XBus implementation to use for the plugin. |

package/docs/API-reference/api/x-components.xplugin.adapter.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## XPlugin.adapter property
- Is the middleware between the components and our API where data can be mapped to client needs. This property is only available after installing the plugin.
+XComponentsAdapter Is the middleware between the components and our API where data can be mapped to client needs. This property is only available after installing the plugin.
 **Signature:**

package/docs/API-reference/api/x-components.xplugin.bus.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## XPlugin.bus property
-Exposed , so any kind of application can subscribe to [XEventsTypes](./x-components.xeventstypes.md) without having to pass through a component. This property is only available after installing the plugin.
+Exposed XBus, so any kind of application can subscribe to [XEventsTypes](./x-components.xeventstypes.md) without having to pass through a component. This property is only available after installing the plugin.
 **Signature:**

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

@@ -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. |
@@ -96,7 +97,7 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [TrackableRequest](./x-types.trackablerequest.md) | Interface for any Request with tagging. |
 |  [TrackableShowResponse](./x-types.trackableshowresponse.md) | Response to be implemented by all responses that contain a part to track the show event. |
 |  [UserInfo](./x-types.userinfo.md) | The representation of the user. |
-|  [XComponentsAdapter](./x-types.xcomponentsadapter.md) |  |
+|  [XComponentsAdapter](./x-types.xcomponentsadapter.md) | XComponentsAdapter. |
 ## Variables

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

@@ -17,7 +17,11 @@ export interface RelatedPrompt extends NamedModel<'RelatedPrompt'>
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [nextQueries](./x-types.relatedprompt.nextqueries.md) |  | string\[\] | The next queries related to the prompt. |
+|  [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. |
+|  [suggestionImageUrl?](./x-types.relatedprompt.suggestionimageurl.md) |  | string | _(Optional)_ The prompt image |
 |  [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 CHANGED Viewed

@@ -4,7 +4,7 @@
 ## RelatedPrompt.nextQueries property
-The next queries related to the prompt.
+The queries of the next queries related to the prompt.
 **Signature:**

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

@@ -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.suggestionimageurl.md ADDED Viewed

@@ -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; [suggestionImageUrl](./x-types.relatedprompt.suggestionimageurl.md)
+## RelatedPrompt.suggestionImageUrl property
+The prompt image
+**Signature:**
+```typescript
+suggestionImageUrl?: string;
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [tagging](./x-types.relatedprompt.tagging.md)
+## RelatedPrompt.tagging property
+Related prompt tagging.
+**Signature:**
+```typescript
+tagging?: {
+        toolingDisplayTagging?: TaggingRequest;
+        toolingDisplayClickTagging?: TaggingRequest;
+        nextQueriesTagging?: RelatedPromptNextQuery[];
+    };
+```

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

@@ -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; [toolingDisplayTagging](./x-types.relatedprompt.toolingdisplaytagging.md)
+## RelatedPrompt.toolingDisplayTagging property
+The tooling display tagging of the prompt.
+**Signature:**
+```typescript
+toolingDisplayTagging?: TaggingRequest;
+```

package/docs/API-reference/api/x-types.relatedpromptnextquery.md ADDED Viewed

@@ -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; [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md)
+## RelatedPromptNextQuery interface
+Represents a related prompt nextQuery.
+**Signature:**
+```typescript
+export interface RelatedPromptNextQuery
+```
+## Properties
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [query](./x-types.relatedpromptnextquery.query.md) |  | string | The query of the next query. |
+|  [toolingDisplayAdd2CartTagging](./x-types.relatedpromptnextquery.toolingdisplayadd2carttagging.md) |  | [TaggingRequest](./x-types.taggingrequest.md) | The tooling display add2cart tagging of the next query. |
+|  [toolingDisplayClickTagging](./x-types.relatedpromptnextquery.toolingdisplayclicktagging.md) |  | [TaggingRequest](./x-types.taggingrequest.md) | The tooling display click tagging of the next query. |
+|  [toolingDisplayTagging](./x-types.relatedpromptnextquery.toolingdisplaytagging.md) |  | [TaggingRequest](./x-types.taggingrequest.md) | The tooling display tagging of the next query. |

package/docs/API-reference/api/x-types.relatedpromptnextquery.query.md ADDED Viewed

@@ -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; [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md) &gt; [query](./x-types.relatedpromptnextquery.query.md)
+## RelatedPromptNextQuery.query property
+The query of the next query.
+**Signature:**
+```typescript
+query: string;
+```

package/docs/API-reference/api/x-types.relatedpromptnextquery.toolingdisplayadd2carttagging.md ADDED Viewed

@@ -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; [RelatedPromptNextQuery](./x-types.relatedpromptnextquery.md) &gt; [toolingDisplayAdd2CartTagging](./x-types.relatedpromptnextquery.toolingdisplayadd2carttagging.md)
+## RelatedPromptNextQuery.toolingDisplayAdd2CartTagging property
+The tooling display add2cart tagging of the next query.
+**Signature:**
+```typescript
+toolingDisplayAdd2CartTagging: TaggingRequest;
+```