@empathyco/x-components 3.0.0-alpha.31 → 3.0.0-alpha.35

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

@@ -71,6 +71,8 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [FiltersInjectionMixin](./x-components.filtersinjectionmixin.md) | Mixin to share filters injection logic. |
 |  [FiltersList](./x-components.filterslist.md) | Renders a list with a list item per each [BooleanFilter](./x-types.booleanfilter.md) in the filters prop array. Each list item has a scoped slot, passing the filter as slot prop. |
 |  [FiltersSearch](./x-components.filterssearch.md) | Renders the filters sifted with the input query. |
+|  [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md) | Component for use as Layout to be filled with the rest of the components. |
+|  [GlobalXBus](./x-components.globalxbus.md) | This component helps subscribing to any [XEvent](./x-components.xevent.md) with custom callbacks using Vue listeners API. |
 |  [HierarchicalFilter](./x-components.hierarchicalfilter.md) | Renders a hierarchical filter recursively, emitting the needed events when clicked. |
 |  [HistoryQueries](./x-components.historyqueries.md) | This component renders a list of suggestions coming from the user queries history. |
 |  [HistoryQueriesGetter](./x-components.historyqueriesgetter.md) | Class implementation for the [HistoryQueriesGetters.historyQueries](./x-components.historyqueriesgetters.historyqueries.md) getter. |
@@ -115,6 +117,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [SingleColumnLayout](./x-components.singlecolumnlayout.md) | Component for use as Layout to be filled with the rest of the Components. |
 |  [SlicedFilters](./x-components.slicedfilters.md) | Component that slices a list of filters and returns them using the default scoped slot, allowing the user to show the full list of them or slicing them again using the show more/less buttons. |
 |  [SlidingPanel](./x-components.slidingpanel.md) | Horizontal slide panel component. The content that is provided to this component would be navigable horizontally using two navigational buttons. |
+|  [SnippetCallbacks](./x-components.snippetcallbacks.md) | This component subscribes to any [XEvent](./x-components.xevent.md) with a custom callbacks provided by the snippet configuration. |
 |  [SnippetConfigExtraParams](./x-components.snippetconfigextraparams.md) | Extracts the extra parameters from the [SnippetConfig](./x-components.snippetconfig.md) and syncs it with the request objects of every x-module. |
 |  [SortDropdown](./x-components.sortdropdown.md) | The <code>SortDropdown</code> component allows user to select the search results order. This component also allows to change the selected sort programmatically. |
 |  [SortedFilters](./x-components.sortedfilters.md) | Component that sorts a list of filters and returns them using the default scoped slot. |
@@ -124,6 +127,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [SpellcheckButton](./x-components.spellcheckbutton.md) | A button that when pressed emits the [XEventsTypes.UserAcceptedAQuery](./x-components.xeventstypes.useracceptedaquery.md) and [XEventsTypes.UserAcceptedSpellcheckQuery](./x-components.xeventstypes.useracceptedspellcheckquery.md) events, expressing the user intention to set the spellchecked query. |
 |  [StaggeredFadeAndSlide](./x-components.staggeredfadeandslide.md) | Renders a transition group wrapping the elements passed in the default slot and animating them with an staggered fade and slide animation. |
 |  [StaggeringTransitionGroup](./x-components.staggeringtransitiongroup.md) | A replacement component for Vue's transition-group, that also adds the option to stagger the animations. |
+|  [Tagging](./x-components.tagging.md) | This component enables and manages the sending of information to the [Empathy Tagging API](https://empathy.co/docs/tagging-api/)<!-- -->. It allows to enable or disable the session id management through the <code>consent</code> prop. |
 |  [TranslateFromLeft](./x-components.translatefromleft.md) | Renders a transition wrapping the element passed in the default slot and moving it to its desired position. |
 |  [TranslateFromRight](./x-components.translatefromright.md) | Renders a transition wrapping the element passed in the default slot and moving it to its desired position. |
 |  [UrlHandler](./x-components.urlhandler.md) | This component manage the browser URL parameters to perserve 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. |
@@ -149,7 +153,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [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. |
 |  [createWiring(wiring)](./x-components.createwiring.md) | Util function to generate type-safe wiring. If TypeScript ever accepts the PR about generic type inference this function can be removed. |
 |  [currencyFormatter(value, format)](./x-components.currencyformatter.md) | Format a value with a given format. |
-|  [debounce(wire, timeInMs, raceEvent)](./x-components.debounce.md) | Creates a debounced [Wire](./x-components.wire.md)<!-- -->. Being debounced means that it will only be executed after the time given by <code>timeInMs</code> has passed without invoking it. |
+|  [debounce(wire, timeInMs, options)](./x-components.debounce.md) | Creates a debounced [Wire](./x-components.wire.md)<!-- -->. Being debounced means that it will only be executed after the time given by <code>timeInMs</code> has passed without invoking it. |
 |  [Debounce(debounceTimeInMs, debounceOptions)](./x-components.debounce.md) | Adds debounce to the method that the decorator is applied to. |
 |  [deepFilter(array, filter, childrenKey)](./x-components.deepfilter.md) | Filters an array with all elements that pass the test implemented by the provided filter function. It also does it recursively if the property accessed, whose name is the parameter childrenKey, to the current iteration in an array. |
 |  [deepFlat(array, childrenKey)](./x-components.deepflat.md) | Flat an ArrayType\[\] recursively using the childrenKey passed as parameter to access to his nested child which is also ArrayType\[\]. |
@@ -182,7 +186,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [reduce(obj, reducer, initialValue)](./x-components.reduce.md) | Iterates through the obj properties calling the reducer function. |
 |  [setStatus(state, status)](./x-components.setstatus.md) | Sets the request status. Can be used as a mutation. |
 |  [State(module, path)](./x-components.state.md) | Generates a computed property which returns the selected state.<!-- -->The decorated property needs to be public for type inference to work. |
-|  [throttle(wire, timeInMs, raceEvent)](./x-components.throttle.md) | Creates a throttled [Wire](./x-components.wire.md)<!-- -->. Being throttled means that it will only be executed once every couple of milliseconds given by the <code>timeInMs</code> parameter. |
+|  [throttle(wire, timeInMs, options)](./x-components.throttle.md) | Creates a throttled [Wire](./x-components.wire.md)<!-- -->. Being throttled means that it will only be executed once every couple of milliseconds given by the <code>timeInMs</code> parameter. |
 |  [toKebabCase(str)](./x-components.tokebabcase.md) | Util to transform string a into kebab case. |
 |  [wireCommit(mutation, payloadFactory)](./x-components.wirecommit.md) | Creates a wire that commits a mutation to the store. This wire receives a function. This function is used to get the actual payload value passed to mutation. This wire can be used in every event, as it does not have a payload type associated. |
 |  [wireCommit(mutation, staticPayload)](./x-components.wirecommit_1.md) | Creates a wire that commits a mutation to the store. This wire can receive any value as payload. This wire can be used in every event, as it does not have a payload type associated. |
@@ -313,6 +317,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [TaggingState](./x-components.taggingstate.md) | Tagging store state. |
 |  [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. |
 |  [UrlActions](./x-components.urlactions.md) | URL store actions. |
 |  [UrlGetters](./x-components.urlgetters.md) | URL store getters. |
 |  [UrlMutations](./x-components.urlmutations.md) | URL store mutations. |
@@ -326,7 +331,6 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [XActionContext](./x-components.xactioncontext.md) | Type safe Vuex [Action](https://vuex.vuejs.org/api/#actions) context, with the local types of the module. |
 |  [XAPI](./x-components.xapi.md) | Interface with the API functions exposes as X [window](https://developer.mozilla.org/en-US/docs/Web/API/Window) property. |
 |  [XBus](./x-components.xbus.md) | The events bus that allows emitting and subscribing to [XEventsTypes](./x-components.xeventstypes.md)<!-- -->. |
-|  [XComponent](./x-components.xcomponent.md) | An XComponent is just a normal Vue component that has an [XModule](./x-components.xmodule.md) linked to its usage. If the XComponent is imported in a consumer project, the [XModule](./x-components.xmodule.md) will be registered. |
 |  [XComponentAliasAPI](./x-components.xcomponentaliasapi.md) | Alias to facilitate retrieving values from the store. |
 |  [XComponentAliasQueryAPI](./x-components.xcomponentaliasqueryapi.md) | Alias to facilitate retrieving the modules with query. |
 |  [XComponentAliasStatusAPI](./x-components.xcomponentaliasstatusapi.md) | Alias to facilitate retrieving the modules with status. |
@@ -524,11 +528,14 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [StarIcon](./x-components.staricon.md) |  |
 |  [storageKey](./x-components.storagekey.md) | Default implementation for the [HistoryQueriesGetters.storageKey](./x-components.historyqueriesgetters.storagekey.md) getter. |
 |  [taggingXModule](./x-components.taggingxmodule.md) | Tagging [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>empathize</code> entry point. |
+|  [TagIcon](./x-components.tagicon.md) |  |
 |  [throttleFunction](./x-components.throttlefunction.md) | Util function that returns a throttled version of the function passed as parameter. |
 |  [toggleRelatedTag](./x-components.togglerelatedtag.md) | Default implementation for the [RelatedTagsActions.toggleRelatedTag()](./x-components.relatedtagsactions.togglerelatedtag.md)<!-- -->. |
 |  [toggleRelatedTagWire](./x-components.togglerelatedtagwire.md) | Sets the selected related tags. |
 |  [track](./x-components.track.md) | Default implementation for the [TaggingActions.track()](./x-components.taggingactions.track.md)<!-- -->. |
-|  [trackWire](./x-components.trackwire.md) | Tracks the tagging of the query using a debounce which ends if the user accepts a query. |
+|  [trackAddToCartWire](./x-components.trackaddtocartwire.md) | Performs a track of a result added to the cart. |
+|  [trackQueryWire](./x-components.trackquerywire.md) | Tracks the tagging of the query using a debounce which ends if the user accepts a query. |
+|  [trackResultClickedWire](./x-components.trackresultclickedwire.md) | Tracks the tagging of the result. |
 |  [TrashIcon](./x-components.trashicon.md) |  |
 |  [TrashOpenIcon](./x-components.trashopenicon.md) |  |
 |  [TrendingIcon](./x-components.trendingicon.md) |  |
@@ -594,12 +601,13 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [IdentifierResultsXModule](./x-components.identifierresultsxmodule.md) | IdentifierResults [XModule](./x-components.xmodule.md) alias. |
 |  [IdentifierResultsXStoreModule](./x-components.identifierresultsxstoremodule.md) | IdentifierResults type safe store module. |
 |  [ListItem](./x-components.listitem.md) | Type representing a grid item. It has to be an [Identifiable](./x-types.identifiable.md) object that can optionally contain a [modelName](./x-types.namedmodel.modelname.md)<!-- -->. |
+|  [MaybeArray](./x-components.maybearray.md) | Alias for a type that might be an array or not. |
 |  [MonadicFunction](./x-components.monadicfunction.md) | A function with a single parameter that can return anything. |
 |  [MutationNamesFor](./x-components.mutationnamesfor.md) | Returns the mutation names for a given module. They are the namespaced mutations. |
 |  [MutationsDictionary](./x-components.mutationsdictionary.md) | Util type for being used on generic constraints which will only accept an object containing mutations. |
 |  [MutationsTree](./x-components.mutationstree.md) | Type-safe mutations definition type. An object with this type is what it is needed to define [Vuex](https://vuex.vuejs.org/) mutations. |
-|  [NamespacedTimeRetrieving](./x-components.namespacedtimeretrieving.md) | Function type which receives the State and the Getters of the namespace [XStoreModule](./x-components.xstoremodule.md) to retrieve the time from there. |
-|  [NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md) | Function type which receives the wire to modify and the [NamespacedTimeRetrieving](./x-components.namespacedtimeretrieving.md) to retrieve the time from the [XStoreModule](./x-components.xstoremodule.md)<!-- -->. |
+|  [NamespacedTimeSelector](./x-components.namespacedtimeselector.md) | Function type which receives the State and the Getters of the namespace [XStoreModule](./x-components.xstoremodule.md) to retrieve the time from there. |
+|  [NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md) | Function type which receives the wire to modify and the [NamespacedTimeSelector](./x-components.namespacedtimeselector.md) to retrieve the time from the [XStoreModule](./x-components.xstoremodule.md)<!-- -->. |
 |  [NamespacedWireCommitPayload](./x-components.namespacedwirecommitpayload.md) | Namespaced payload to commit a mutation. Either a function that receives the [module state and getters](./x-components.storemodulestateandgetters.md) and returns the payload for the mutation, or a static action payload. |
 |  [NamespacedWireCommitWithoutPayload](./x-components.namespacedwirecommitwithoutpayload.md) | Namespaced type for the [wireCommitWithoutPayload()](./x-components.wirecommitwithoutpayload.md) which creates a wire without payload associated. |
 |  [NamespacedWireDispatchPayload](./x-components.namespacedwiredispatchpayload.md) | Namespaced payload to dispatch an action. Either a function that receives the [module state and getters](./x-components.storemodulestateandgetters.md) and returns the payload for the action, or a static action payload. |
@@ -649,7 +657,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [TaggingXModule](./x-components.taggingxmodule.md) | Tagging [XModule](./x-components.xmodule.md) alias. |
 |  [TaggingXStoreModule](./x-components.taggingxstoremodule.md) | Tagging type safe store module. |
 |  [TakeNavigationControl](./x-components.takenavigationcontrol.md) | Represents when to take control of the navigation. |
-|  [TimeRetrieving](./x-components.timeretrieving.md) | Function type which receives the whole store as parameter and retrieve the time from there. |
+|  [TimeSelector](./x-components.timeselector.md) | Function type which receives the whole store as parameter and retrieve the time from there. |
 |  [UrlActionContext](./x-components.urlactioncontext.md) | Alias type for actions context of the [UrlXStoreModule](./x-components.urlxstoremodule.md)<!-- -->. |
 |  [UrlParamKey](./x-components.urlparamkey.md) | The key of the parameter to store in the URL. |
 |  [UrlParamValue](./x-components.urlparamvalue.md) | The allowed values of the parameters to store in the URL. |
@@ -662,6 +670,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [WireForEvent](./x-components.wireforevent.md) | Alias for a wire with the type of the event payload. |
 |  [Wiring](./x-components.wiring.md) | The Wiring is a record where each key is an EmpathyX event, and the value is a dictionary of wires. |
 |  [XEvent](./x-components.xevent.md) | Name of all available events. |
+|  [XEventListeners](./x-components.xeventlisteners.md) | Map type of every [XEvent](./x-components.xevent.md) and a callback with the payload and metadata for that event. |
 |  [XEventPayload](./x-components.xeventpayload.md) | Extracts the payload type of an event. |
 |  [XEventsOf](./x-components.xeventsof.md) | Selects events of the with a payload matching the provided type. |
 |  [XModuleName](./x-components.xmodulename.md) | Names of all of the [XModules](./x-components.xmodule.md) available. |

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

@@ -9,7 +9,7 @@ Type safe debounce operator which creates a function which can only access the M
 <b>Signature:</b>
 
 ```typescript
-export declare function namespacedDebounce<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName, AnyWire>;
+export declare function namespacedDebounce<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName>;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ export declare function namespacedDebounce<ModuleName extends XModuleName>(modul
 
 <b>Returns:</b>
 
-[NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md)<!-- -->&lt;ModuleName, [AnyWire](./x-components.anywire.md)<!-- -->&gt;
+[NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md)<!-- -->&lt;ModuleName&gt;
 
 A function which creates a wire that uses the [debounce()](./x-components.debounce.md) wire operator to execute the `wire` after the time has passed without invoking it. This debounce time is given by the execution of the `timeRetrieving` function.
 

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

@@ -9,7 +9,7 @@ Type safe throttle operator which creates a function which can only access the M
 <b>Signature:</b>
 
 ```typescript
-export declare function namespacedThrottle<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName, AnyWire>;
+export declare function namespacedThrottle<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName>;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ export declare function namespacedThrottle<ModuleName extends XModuleName>(modul
 
 <b>Returns:</b>
 
-[NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md)<!-- -->&lt;ModuleName, [AnyWire](./x-components.anywire.md)<!-- -->&gt;
+[NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md)<!-- -->&lt;ModuleName&gt;
 
 A function which creates a wire that uses the [throttle()](./x-components.throttle.md) wire operator to execute the `wire` once every couple of milliseconds. This throttle time is given by the execution of the `timeRetrieving` function.
 

package/docs/API-reference/api/{x-components.namespacedtimeretrieving.md → x-components.namespacedtimeselector.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NamespacedTimeRetrieving](./x-components.namespacedtimeretrieving.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NamespacedTimeSelector](./x-components.namespacedtimeselector.md)
 
-## NamespacedTimeRetrieving type
+## NamespacedTimeSelector type
 
 Function type which receives the State and the Getters of the namespace [XStoreModule](./x-components.xstoremodule.md) to retrieve the time from there.
 
 <b>Signature:</b>
 
 ```typescript
-export declare type NamespacedTimeRetrieving<ModuleName extends XModuleName> = (storeModule: StoreModuleStateAndGetters<ModuleName>) => number;
+export declare type NamespacedTimeSelector<ModuleName extends XModuleName> = (storeModule: StoreModuleStateAndGetters<ModuleName>) => number;
 ```
 <b>References:</b> [XModuleName](./x-components.xmodulename.md)<!-- -->, [StoreModuleStateAndGetters](./x-components.storemodulestateandgetters.md)
 

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

@@ -4,12 +4,12 @@
 
 ## NamespacedTimeWireOperator type
 
-Function type which receives the wire to modify and the [NamespacedTimeRetrieving](./x-components.namespacedtimeretrieving.md) to retrieve the time from the [XStoreModule](./x-components.xstoremodule.md)<!-- -->.
+Function type which receives the wire to modify and the [NamespacedTimeSelector](./x-components.namespacedtimeselector.md) to retrieve the time from the [XStoreModule](./x-components.xstoremodule.md)<!-- -->.
 
 <b>Signature:</b>
 
 ```typescript
-export declare type NamespacedTimeWireOperator<ModuleName extends XModuleName, Wire> = (wire: Wire, timeRetrieving: NamespacedTimeRetrieving<ModuleName>, raceEvent?: XEvent | XEvent[]) => Wire;
+export declare type NamespacedTimeWireOperator<ModuleName extends XModuleName> = <Payload>(wire: Wire<Payload>, timeInMs: NamespacedTimeSelector<ModuleName>, options?: TimedWireOperatorOptions) => Wire<Payload>;
 ```
-<b>References:</b> [XModuleName](./x-components.xmodulename.md)<!-- -->, [NamespacedTimeRetrieving](./x-components.namespacedtimeretrieving.md)<!-- -->, [XEvent](./x-components.xevent.md)
+<b>References:</b> [XModuleName](./x-components.xmodulename.md)<!-- -->, [Wire](./x-components.wire.md)<!-- -->, [NamespacedTimeSelector](./x-components.namespacedtimeselector.md)<!-- -->, [TimedWireOperatorOptions](./x-components.timedwireoperatoroptions.md)
 

package/docs/API-reference/api/x-components.relatedtag.highlightcurated.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; [RelatedTag](./x-components.relatedtag.md) &gt; [highlightCurated](./x-components.relatedtag.highlightcurated.md)
+
+## RelatedTag.highlightCurated property
+
+Indicates if the curated related tag should be highlighted.
+
+<b>Signature:</b>
+
+```typescript
+protected highlightCurated: boolean;
+```

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

@@ -17,6 +17,7 @@ export default class RelatedTag extends Vue
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [highlightCurated](./x-components.relatedtag.highlightcurated.md) |  | boolean | Indicates if the curated related tag should be highlighted. |
 |  [relatedTag](./x-components.relatedtag.relatedtag.md) |  | RelatedTagModel | The related tag model data. |
 
 ## Methods

package/docs/API-reference/api/x-components.relatedtags.highlightcurated.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; [RelatedTags](./x-components.relatedtags.md) &gt; [highlightCurated](./x-components.relatedtags.highlightcurated.md)
+
+## RelatedTags.highlightCurated property
+
+Flag to indicate if the curated tags should be displayed different.
+
+<b>Signature:</b>
+
+```typescript
+protected highlightCurated: boolean;
+```

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

@@ -24,7 +24,9 @@ export interface SearchXEvents
 |  [SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md) | Sort | A new selected sort has been provided. \* Payload: The sort option that has been provided. |
 |  [SortChanged](./x-components.searchxevents.sortchanged.md) | string | Sort has been changed. \* Payload: The new sort string. |
 |  [SpellcheckChanged](./x-components.searchxevents.spellcheckchanged.md) | string | Spellcheck has been changed. \* Payload: The new spellcheckedQuery string. |
+|  [UserClickedABanner](./x-components.searchxevents.userclickedabanner.md) | Banner | The user has clicked a banner. \* Payload: The clicked banner. |
 |  [UserClickedAbortARedirection](./x-components.searchxevents.userclickedabortaredirection.md) | void | The user has aborted a redirection. |
+|  [UserClickedAPromoted](./x-components.searchxevents.userclickedapromoted.md) | Promoted | The user has clicked a promoted. \* Payload: The clicked promoted. |
 |  [UserClickedARedirection](./x-components.searchxevents.userclickedaredirection.md) | Redirection | The user has clicked a redirection. \* Payload: The clicked redirection. |
 |  [UserClickedASort](./x-components.searchxevents.userclickedasort.md) | Sort | The user has clicked one of the sorts. \* Payload: The sort option that the user has selected. |
 |  [UserClickedPartialQuery](./x-components.searchxevents.userclickedpartialquery.md) | string | Partial query has been set. \* Payload: The new query string. |

package/docs/API-reference/api/x-components.searchxevents.userclickedabanner.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; [SearchXEvents](./x-components.searchxevents.md) &gt; [UserClickedABanner](./x-components.searchxevents.userclickedabanner.md)
+
+## SearchXEvents.UserClickedABanner property
+
+The user has clicked a banner. \* Payload: The clicked banner.
+
+<b>Signature:</b>
+
+```typescript
+UserClickedABanner: Banner;
+```

package/docs/API-reference/api/x-components.searchxevents.userclickedapromoted.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; [SearchXEvents](./x-components.searchxevents.md) &gt; [UserClickedAPromoted](./x-components.searchxevents.userclickedapromoted.md)
+
+## SearchXEvents.UserClickedAPromoted property
+
+The user has clicked a promoted. \* Payload: The clicked promoted.
+
+<b>Signature:</b>
+
+```typescript
+UserClickedAPromoted: Promoted;
+```

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

@@ -9,5 +9,5 @@ Sets the tagging state `consent`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setConsent: import("../../wiring").Wire<boolean>
+setConsent: Wire<boolean>
 ```

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

@@ -9,5 +9,5 @@ Sets the tagging state config `queryTaggingDebounceMs`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setQueryTaggingDebounce: import("../../wiring").Wire<number>
+setQueryTaggingDebounce: Wire<number>
 ```

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

@@ -9,5 +9,5 @@ Sets the tagging state `sessionTTLMs`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSessionDuration: import("../../wiring").Wire<number>
+setSessionDuration: Wire<number>
 ```

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SnippetCallbacks](./x-components.snippetcallbacks.md)
+
+## SnippetCallbacks class
+
+This component subscribes to any [XEvent](./x-components.xevent.md) with a custom callbacks provided by the snippet configuration.
+
+<b>Signature:</b>
+
+```typescript
+export default class SnippetCallbacks extends Vue 
+```
+<b>Extends:</b> Vue
+

package/docs/API-reference/api/x-components.snippetconfig.callbacks.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; [SnippetConfig](./x-components.snippetconfig.md) &gt; [callbacks](./x-components.snippetconfig.callbacks.md)
+
+## SnippetConfig.callbacks property
+
+Callbacks to be triggered when an XEvent is emitted.
+
+<b>Signature:</b>
+
+```typescript
+callbacks?: XEventListeners;
+```

package/docs/API-reference/api/x-components.snippetconfig.isspa.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; [SnippetConfig](./x-components.snippetconfig.md) &gt; [isSpa](./x-components.snippetconfig.isspa.md)
+
+## SnippetConfig.isSpa property
+
+Flag determining if the page is a single page application or not.
+
+<b>Signature:</b>
+
+```typescript
+isSpa?: boolean;
+```

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

@@ -16,11 +16,13 @@ export interface SnippetConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [callbacks?](./x-components.snippetconfig.callbacks.md) | [XEventListeners](./x-components.xeventlisteners.md) | <i>(Optional)</i> Callbacks to be triggered when an XEvent is emitted. |
 |  [consent?](./x-components.snippetconfig.consent.md) | boolean | <i>(Optional)</i> User GDPR consent. |
 |  [currency?](./x-components.snippetconfig.currency.md) | string | <i>(Optional)</i> The currency name. There should be a currency format associated to this name in the app. |
 |  [documentDirection?](./x-components.snippetconfig.documentdirection.md) | [DocumentDirection](./x-components.documentdirection.md) | <i>(Optional)</i> Document direction. |
 |  [env?](./x-components.snippetconfig.env.md) | 'live' \| 'staging' | <i>(Optional)</i> Backend services environment. |
 |  [instance](./x-components.snippetconfig.instance.md) | string | Customer instance. |
+|  [isSpa?](./x-components.snippetconfig.isspa.md) | boolean | <i>(Optional)</i> Flag determining if the page is a single page application or not. |
 |  [lang](./x-components.snippetconfig.lang.md) | string | Language to display. |
 |  [scope](./x-components.snippetconfig.scope.md) | string | Execution scope (desktop, mobile, app, ...). |
 |  [searchLang?](./x-components.snippetconfig.searchlang.md) | string | <i>(Optional)</i> Language to send to backend services. |

package/docs/API-reference/api/x-components.tagging.activeconsent.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; [Tagging](./x-components.tagging.md) &gt; [activeConsent](./x-components.tagging.activeconsent.md)
+
+## Tagging.activeConsent property
+
+The active consent, selected from the `consent` prop and the `snippetConfig.consent` property. False by default.
+
+<b>Signature:</b>
+
+```typescript
+get activeConsent(): boolean;
+```
+
+## Remarks
+
+If the consent is undefined in the prop and in the snippetConfig, it will return false.
+

package/docs/API-reference/api/x-components.tagging.consent.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; [Tagging](./x-components.tagging.md) &gt; [consent](./x-components.tagging.consent.md)
+
+## Tagging.consent property
+
+The consent to be emitted.
+
+<b>Signature:</b>
+
+```typescript
+protected consent?: boolean;
+```

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [Tagging](./x-components.tagging.md)
+
+## Tagging class
+
+This component enables and manages the sending of information to the [Empathy Tagging API](https://empathy.co/docs/tagging-api/)<!-- -->. It allows to enable or disable the session id management through the `consent` prop.
+
+<b>Signature:</b>
+
+```typescript
+export default class Tagging extends Vue 
+```
+<b>Extends:</b> Vue
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [activeConsent](./x-components.tagging.activeconsent.md) |  | boolean | The active consent, selected from the <code>consent</code> prop and the <code>snippetConfig.consent</code> property. False by default. |
+|  [consent?](./x-components.tagging.consent.md) |  | boolean | <i>(Optional)</i> The consent to be emitted. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [render()](./x-components.tagging.render.md) |  |  |
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [Tagging](./x-components.tagging.md) &gt; [render](./x-components.tagging.render.md)
+
+## Tagging.render() method
+
+<b>Signature:</b>
+
+```typescript
+render(): void;
+```
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.tagicon.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; [TagIcon](./x-components.tagicon.md)
+
+## TagIcon variable
+
+<b>Signature:</b>
+
+```typescript
+_default: {}
+```

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

@@ -9,7 +9,7 @@ Creates a throttled [Wire](./x-components.wire.md)<!-- -->. Being throttled mean
 <b>Signature:</b>
 
 ```typescript
-export declare function throttle<Payload>(wire: Wire<Payload>, timeInMs: TimeRetrieving | number, raceEvent?: XEvent | XEvent[]): Wire<Payload>;
+export declare function throttle<Payload>(wire: Wire<Payload>, timeInMs: TimeSelector | number, options?: TimedWireOperatorOptions): Wire<Payload>;
 ```
 
 ## Parameters
@@ -17,8 +17,8 @@ export declare function throttle<Payload>(wire: Wire<Payload>, timeInMs: TimeRet
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  wire | [Wire](./x-components.wire.md)<!-- -->&lt;Payload&gt; | The wire to throttle. |
-|  timeInMs | [TimeRetrieving](./x-components.timeretrieving.md) \| number | The time in milliseconds to throttle the wire execution or a function to retrieve it from the store. |
-|  raceEvent | [XEvent](./x-components.xevent.md) \| [XEvent](./x-components.xevent.md)<!-- -->\[\] | The event or events that would prevent the wire execution if at least one of them executes first. |
+|  timeInMs | [TimeSelector](./x-components.timeselector.md) \| number | The time in milliseconds to throttle the wire execution or a function to retrieve it from the store. |
+|  options | [TimedWireOperatorOptions](./x-components.timedwireoperatoroptions.md) | Options to configure this wire with, like an event to force it or cancel it. |
 
 <b>Returns:</b>
 

package/docs/API-reference/api/x-components.timedwireoperatoroptions.cancelon.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; [TimedWireOperatorOptions](./x-components.timedwireoperatoroptions.md) &gt; [cancelOn](./x-components.timedwireoperatoroptions.cancelon.md)
+
+## TimedWireOperatorOptions.cancelOn property
+
+Events that will prevent the next planned execution of the wire to be executed.
+
+<b>Signature:</b>
+
+```typescript
+cancelOn?: MaybeArray<XEvent>;
+```

package/docs/API-reference/api/x-components.timedwireoperatoroptions.forceon.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; [TimedWireOperatorOptions](./x-components.timedwireoperatoroptions.md) &gt; [forceOn](./x-components.timedwireoperatoroptions.forceon.md)
+
+## TimedWireOperatorOptions.forceOn property
+
+Events that will make the next planned execution happen immediately.
+
+<b>Signature:</b>
+
+```typescript
+forceOn?: MaybeArray<XEvent>;
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TimedWireOperatorOptions](./x-components.timedwireoperatoroptions.md)
+
+## TimedWireOperatorOptions interface
+
+Options for wire operators that delay subscribers.
+
+<b>Signature:</b>
+
+```typescript
+export interface TimedWireOperatorOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [cancelOn?](./x-components.timedwireoperatoroptions.cancelon.md) | [MaybeArray](./x-components.maybearray.md)<!-- -->&lt;[XEvent](./x-components.xevent.md)<!-- -->&gt; | <i>(Optional)</i> Events that will prevent the next planned execution of the wire to be executed. |
+|  [forceOn?](./x-components.timedwireoperatoroptions.forceon.md) | [MaybeArray](./x-components.maybearray.md)<!-- -->&lt;[XEvent](./x-components.xevent.md)<!-- -->&gt; | <i>(Optional)</i> Events that will make the next planned execution happen immediately. |
+

package/docs/API-reference/api/{x-components.timeretrieving.md → x-components.timeselector.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TimeRetrieving](./x-components.timeretrieving.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TimeSelector](./x-components.timeselector.md)
 
-## TimeRetrieving type
+## TimeSelector type
 
 Function type which receives the whole store as parameter and retrieve the time from there.
 
 <b>Signature:</b>
 
 ```typescript
-export declare type TimeRetrieving = (storeModule: Store<RootXStoreState>) => number;
+export declare type TimeSelector = (storeModule: Store<RootXStoreState>) => number;
 ```
 <b>References:</b> [RootXStoreState](./x-components.rootxstorestate.md)
 

package/docs/API-reference/api/x-components.trackaddtocartwire.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; [trackAddToCartWire](./x-components.trackaddtocartwire.md)
+
+## trackAddToCartWire variable
+
+Performs a track of a result added to the cart.
+
+<b>Signature:</b>
+
+```typescript
+trackAddToCartWire: Wire<Result>
+```

package/docs/API-reference/api/{x-components.trackwire.md → x-components.trackquerywire.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; [trackWire](./x-components.trackwire.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [trackQueryWire](./x-components.trackquerywire.md)
 
-## trackWire variable
+## trackQueryWire variable
 
 Tracks the tagging of the query using a debounce which ends if the user accepts a query.
 
 <b>Signature:</b>
 
 ```typescript
-trackWire: import("../../wiring").AnyWire
+trackQueryWire: Wire<import("@empathyco/x-types").TaggingInfo | import("@empathyco/x-types").TaggingInfo[]>
 ```

package/docs/API-reference/api/x-components.trackresultclickedwire.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; [trackResultClickedWire](./x-components.trackresultclickedwire.md)
+
+## trackResultClickedWire variable
+
+Tracks the tagging of the result.
+
+<b>Signature:</b>
+
+```typescript
+trackResultClickedWire: Wire<Result>
+```

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XEventListeners](./x-components.xeventlisteners.md)
+
+## XEventListeners type
+
+Map type of every [XEvent](./x-components.xevent.md) and a callback with the payload and metadata for that event.
+
+<b>Signature:</b>
+
+```typescript
+export declare type XEventListeners = Partial<{
+    [Event in XEvent]: (payload: XEventPayload<Event>, metadata: WireMetadata) => void;
+}>;
+```
+<b>References:</b> [XEvent](./x-components.xevent.md)<!-- -->, [XEventPayload](./x-components.xeventpayload.md)<!-- -->, [WireMetadata](./x-components.wiremetadata.md)
+