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

package/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0-alpha.35](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.34...@empathyco/x-components@3.0.0-alpha.35) (2021-12-14)
+
+### Features
+
+- **components:** fix 'BaseRating' component styles (#264)
+  ([053447f](https://github.com/empathyco/x/commit/053447fdb2884f04f6099b6b78876c006568a644)),
+  closes [EX-5096](https://searchbroker.atlassian.net/browse/EX-5096)
+- **plugin:** move alias creation from created hook to beforeCreated
+  ([57f98e6](https://github.com/empathyco/x/commit/57f98e6587c0c589c4b6581a5f2c1da1a45757d8)),
+  closes [EX-4331](https://searchbroker.atlassian.net/browse/EX-4331)
+- **tagging:** track pending query
+  ([e6c8fd4](https://github.com/empathyco/x/commit/e6c8fd401b28b2e931ebf78697f218f53134cc5a)),
+  closes [EX-4963](https://searchbroker.atlassian.net/browse/EX-4963)
+- **tagging:** track result click events
+  ([81f009b](https://github.com/empathyco/x/commit/81f009b0a6264c44436082e457bcb4a12daf5d19)),
+  closes [EX-3527](https://searchbroker.atlassian.net/browse/EX-3527)
+- **tagging:** track the 'UserClickedResultAddToCart'event in tagging
+  ([873d345](https://github.com/empathyco/x/commit/873d345d67199a64fe9f10c70944b4f74f290405)),
+  closes [EX-3529](https://searchbroker.atlassian.net/browse/EX-3529)
+- **wiring:** add force and cancel support to debounce and throttle wire operators. Update rxjs to
+  v7. ([1fe2f29](https://github.com/empathyco/x/commit/1fe2f298589b1aa44798f3911379fe11905a43a9)),
+  closes [EX-5123](https://searchbroker.atlassian.net/browse/EX-5123)
+
+### Bug Fixes
+
+- **components:** Export missing layout components
+  ([15986f5](https://github.com/empathyco/x/commit/15986f56b8b78b49abe70936c0bd2ba6d85a6bbb)),
+  closes [EX-5160](https://searchbroker.atlassian.net/browse/EX-5160)
+- **extra-params:** prevent callbacks option from the snippet config to be taken as extra params
+  ([2940d2c](https://github.com/empathyco/x/commit/2940d2c7163904a193c459892792b2153de7d079)),
+  closes [EX-5104](https://searchbroker.atlassian.net/browse/EX-5104)
+
+### Testing
+
+- **e2e:** make url tests intercept tracking and wait for each request
+  ([393dbea](https://github.com/empathyco/x/commit/393dbea71648b010a4f3d197c180c91741c6054b)),
+  closes [EX-5127](https://searchbroker.atlassian.net/browse/EX-5127)
+
+### Documentation
+
+- add guide for integrating X Interface into an existing website
+  ([9e14a52](https://github.com/empathyco/x/commit/9e14a52389c77deede822643e50b34e5bbf78ddf)),
+  closes [EX-5143](https://searchbroker.atlassian.net/browse/EX-5143)
+- change h1 to be h2
+  ([a7e16c6](https://github.com/empathyco/x/commit/a7e16c616fe2593eccf93799f9a46c688857b35b)),
+  closes [EX-5064](https://searchbroker.atlassian.net/browse/EX-5064)
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
 ## [3.0.0-alpha.34](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.33...@empathyco/x-components@3.0.0-alpha.34) (2021-12-03)
 
 ### Features

package/core/index.js

@@ -22,7 +22,7 @@ export { sanitize } from '../js/utils/sanitize.js';
 export { localStorageService } from '../js/utils/storage.js';
 export { capitalize, isStringEmpty, toKebabCase } from '../js/utils/string.js';
 export { throttle as throttleFunction } from '../js/utils/throttle.js';
-export { default as StaggeringTransitionGroup } from '../js/components/staggering-transition-group.vue.js';
+export { default as StaggeringTransitionGroup } from '../js/components/animations/staggering-transition-group.vue.js';
 export { default as StaggeredFadeAndSlide } from '../js/components/animations/staggered-fade-and-slide.vue.js';
 export { default as TranslateFromLeft } from '../js/components/animations/translate-from-left.vue.js';
 export { default as TranslateFromRight } from '../js/components/animations/translate-from-right.vue.js';
@@ -83,16 +83,34 @@ export { default as TrashIcon } from '../js/components/icons/trash.vue.js';
 export { default as TrendingTinyIcon } from '../js/components/icons/trending-tiny.vue.js';
 export { default as TrendingIcon } from '../js/components/icons/trending.vue.js';
 export { default as UserIcon } from '../js/components/icons/user.vue.js';
-export { default as BaseEventsModalClose } from '../js/components/modals/base-events-modal-close.vue.js';
+export { Getter, State } from '../js/components/decorators/store.decorators.js';
+export { RootXStoreModule } from '../js/store/x.module.js';
+export { BaseXBus, bus } from '../js/plugins/x-bus.js';
+export { getXComponentXModuleName, isXComponent } from '../js/components/x-component.utils.js';
+export { createXComponentAPIMixin, getBusAPI, getRootXComponent } from '../js/plugins/x-plugin.mixin.js';
+export { XPlugin, xPlugin } from '../js/plugins/x-plugin.js';
+export { xComponentMixin } from '../js/components/x-component.mixin.js';
+export { createFetchAndSaveActions } from '../js/store/utils/fetch-and-save-action.utils.js';
+export { setStatus } from '../js/store/utils/status-store.utils.js';
+export { createStoreEmitters } from '../js/store/utils/store-emitters.utils.js';
+export { createWireFromFunction, wireCommit, wireCommitWithoutPayload, wireDispatch, wireDispatchWithoutPayload, wireService, wireServiceWithoutPayload } from '../js/wiring/wires.factory.js';
+export { createWiring, getStateAndGettersFromModule } from '../js/wiring/wiring.utils.js';
+export { namespacedWireCommit, namespacedWireCommitWithoutPayload, namespacedWireDispatch, namespacedWireDispatchWithoutPayload } from '../js/wiring/namespaced-wires.factory.js';
 export { default as BaseModal } from '../js/components/modals/base-modal.vue.js';
+export { default as BaseIdModal } from '../js/components/modals/base-id-modal.vue.js';
+export { default as ScrollMixin } from '../js/components/scroll/scroll.mixin.js';
+export { default as BaseScroll } from '../js/components/scroll/base-scroll.vue.js';
+export { default as FixedHeaderAndAsidesLayout } from '../js/components/layouts/fixed-header-and-asides-layout.vue.js';
+export { default as BaseTogglePanel } from '../js/components/panels/base-toggle-panel.vue.js';
+export { default as BaseIdTogglePanel } from '../js/components/panels/base-id-toggle-panel.vue.js';
+export { default as MultiColumnMaxWidthLayout } from '../js/components/layouts/multi-column-max-width-layout.vue.js';
+export { default as SingleColumnLayout } from '../js/components/layouts/single-column-layout.vue.js';
+export { default as BaseEventsModalClose } from '../js/components/modals/base-events-modal-close.vue.js';
 export { default as BaseEventsModal } from '../js/components/modals/base-events-modal.vue.js';
 export { default as BaseEventsModalOpen } from '../js/components/modals/base-events-modal-open.vue.js';
-export { default as BaseIdModal } from '../js/components/modals/base-id-modal.vue.js';
 export { default as BaseIdModalClose } from '../js/components/modals/base-id-modal-close.vue.js';
 export { default as BaseIdModalOpen } from '../js/components/modals/base-id-modal-open.vue.js';
-export { default as BaseTogglePanel } from '../js/components/panels/base-toggle-panel.vue.js';
 export { default as BaseHeaderTogglePanel } from '../js/components/panels/base-header-toggle-panel.vue.js';
-export { default as BaseIdTogglePanel } from '../js/components/panels/base-id-toggle-panel.vue.js';
 export { default as BaseIdTogglePanelButton } from '../js/components/panels/base-id-toggle-panel-button.vue.js';
 export { default as BaseAddToCart } from '../js/components/result/base-result-add-to-cart.vue.js';
 export { default as BaseResultCurrentPrice } from '../js/components/result/base-result-current-price.vue.js';
@@ -101,8 +119,6 @@ export { default as BaseResultLink } from '../js/components/result/base-result-l
 export { default as BaseResultPreviousPrice } from '../js/components/result/base-result-previous-price.vue.js';
 export { default as BaseFallbackImage } from '../js/components/result/base-result-fallback-image.vue.js';
 export { default as BasePlaceholderImage } from '../js/components/result/base-result-placeholder-image.vue.js';
-export { default as ScrollMixin } from '../js/components/scroll/scroll.mixin.js';
-export { default as BaseScroll } from '../js/components/scroll/base-scroll.vue.js';
 export { default as BaseSuggestion } from '../js/components/suggestions/base-suggestion.vue.js';
 export { default as BaseSuggestions } from '../js/components/suggestions/base-suggestions.vue.js';
 export { default as AutoProgressBar } from '../js/components/auto-progress-bar.vue.js';
@@ -114,21 +130,6 @@ export { default as BaseVariableColumnGrid } from '../js/components/base-variabl
 export { Debounce } from '../js/components/decorators/debounce.decorators.js';
 export { default as SlidingPanel } from '../js/components/sliding-panel.vue.js';
 export { default as ItemsList } from '../js/components/items-list.vue.js';
-export { Getter, State } from '../js/components/decorators/store.decorators.js';
-export { RootXStoreModule } from '../js/store/x.module.js';
-export { BaseXBus, bus } from '../js/plugins/x-bus.js';
-export { XComponentModule, getXComponentXModuleName, isXComponent, setXComponentXModuleName } from '../js/components/x-component.utils.js';
-export { createXComponentAPIMixin, getBusAPI, getRootXComponent } from '../js/plugins/x-plugin.mixin.js';
-export { XPlugin, xPlugin } from '../js/plugins/x-plugin.js';
-export { xComponentMixin } from '../js/components/x-component.mixin.js';
-export { createFetchAndSaveActions } from '../js/store/utils/fetch-and-save-action.utils.js';
-export { setStatus } from '../js/store/utils/status-store.utils.js';
-export { createStoreEmitters } from '../js/store/utils/store-emitters.utils.js';
-export { createWireFromFunction, wireCommit, wireCommitWithoutPayload, wireDispatch, wireDispatchWithoutPayload, wireService, wireServiceWithoutPayload } from '../js/wiring/wires.factory.js';
-export { createWiring, getStateAndGettersFromModule } from '../js/wiring/wiring.utils.js';
-export { namespacedWireCommit, namespacedWireCommitWithoutPayload, namespacedWireDispatch, namespacedWireDispatchWithoutPayload } from '../js/wiring/namespaced-wires.factory.js';
-export { default as MultiColumnMaxWidthLayout } from '../js/components/layouts/multi-column-max-width-layout.vue.js';
-export { default as SingleColumnLayout } from '../js/components/layouts/single-column-layout.vue.js';
 export { default as LocationProvider } from '../js/components/location-provider.vue.js';
 export { default as GlobalXBus } from '../js/components/global-x-bus.vue.js';
 export { default as SnippetCallbacks } from '../js/components/snippet-callbacks.vue.js';

package/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

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

@@ -30,7 +30,6 @@ export default class BaseIdTogglePanel extends Vue
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [created()](./x-components.baseidtogglepanel.created.md) |  | Creates the watcher over <code>isOpen</code> state to emit the event [XEventsTypes.TogglePanelStateChanged](./x-components.xeventstypes.togglepanelstatechanged.md)<!-- -->. |
 |  [emitStateEvent()](./x-components.baseidtogglepanel.emitstateevent.md) |  | Emits the [XEventsTypes.TogglePanelStateChanged](./x-components.xeventstypes.togglepanelstatechanged.md) event, when the internal state changes. |
 |  [togglePanel(panelId)](./x-components.baseidtogglepanel.togglepanel.md) |  | Method to subscribe to the [XEventsTypes.UserClickedPanelToggleButton](./x-components.xeventstypes.userclickedpaneltogglebutton.md) event. |
 

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

@@ -15,7 +15,7 @@ export default class BaseResultLink extends Vue
 
 ## Remarks
 
-It has the logic to emit [XEventsTypes.UserClickedAResult](./x-components.xeventstypes.userclickedaresult.md) and [XEventsTypes.UserRightClickedAResult](./x-components.xeventstypes.userrightclickedaresult.md) to the bus on click mouse events. Additionally, this component may be injected other events to be emitted on click event, so, depending where it's used its father component may provide this events.
+It has the logic to emit [XEventsTypes.UserClickedAResult](./x-components.xeventstypes.userclickedaresult.md) to the bus on click mouse events. Additionally, this component may be injected other events to be emitted on click event, so, depending where it's used its father component may provide this events.
 
 ## Properties
 

package/docs/API-reference/api/x-components.fixedheaderandasideslayout.isbackdropvisible.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; [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md) &gt; [isBackdropVisible](./x-components.fixedheaderandasideslayout.isbackdropvisible.md)
+
+## FixedHeaderAndAsidesLayout.isBackdropVisible property
+
+<b>Signature:</b>
+
+```typescript
+protected get isBackdropVisible(): boolean;
+```

package/docs/API-reference/api/x-components.fixedheaderandasideslayout.leftasideanimation.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; [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md) &gt; [leftAsideAnimation](./x-components.fixedheaderandasideslayout.leftasideanimation.md)
+
+## FixedHeaderAndAsidesLayout.leftAsideAnimation property
+
+<b>Signature:</b>
+
+```typescript
+protected leftAsideAnimation: import("vue").VueConstructor<MainScroll>;
+```

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md)
+
+## FixedHeaderAndAsidesLayout class
+
+Component for use as Layout to be filled with the rest of the components.
+
+<b>Signature:</b>
+
+```typescript
+export default class FixedHeaderAndAsidesLayout extends FixedHeaderAndAsidesLayout_base 
+```
+<b>Extends:</b> FixedHeaderAndAsidesLayout\_base
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isBackdropVisible](./x-components.fixedheaderandasideslayout.isbackdropvisible.md) |  | boolean |  |
+|  [leftAsideAnimation](./x-components.fixedheaderandasideslayout.leftasideanimation.md) |  | import("vue").VueConstructor&lt;MainScroll&gt; |  |
+|  [rightAsideAnimation](./x-components.fixedheaderandasideslayout.rightasideanimation.md) |  | import("vue").VueConstructor&lt;MainScroll&gt; |  |
+|  [scrollPosition](./x-components.fixedheaderandasideslayout.scrollposition.md) |  | number |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [setPosition(position)](./x-components.fixedheaderandasideslayout.setposition.md) |  |  |
+

package/docs/API-reference/api/x-components.fixedheaderandasideslayout.rightasideanimation.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; [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md) &gt; [rightAsideAnimation](./x-components.fixedheaderandasideslayout.rightasideanimation.md)
+
+## FixedHeaderAndAsidesLayout.rightAsideAnimation property
+
+<b>Signature:</b>
+
+```typescript
+protected rightAsideAnimation: import("vue").VueConstructor<MainScroll>;
+```

package/docs/API-reference/api/x-components.fixedheaderandasideslayout.scrollposition.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; [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md) &gt; [scrollPosition](./x-components.fixedheaderandasideslayout.scrollposition.md)
+
+## FixedHeaderAndAsidesLayout.scrollPosition property
+
+<b>Signature:</b>
+
+```typescript
+protected scrollPosition: number;
+```

package/docs/API-reference/api/x-components.fixedheaderandasideslayout.setposition.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; [FixedHeaderAndAsidesLayout](./x-components.fixedheaderandasideslayout.md) &gt; [setPosition](./x-components.fixedheaderandasideslayout.setposition.md)
+
+## FixedHeaderAndAsidesLayout.setPosition() method
+
+<b>Signature:</b>
+
+```typescript
+protected setPosition(position: number): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  position | number |  |
+
+<b>Returns:</b>
+
+void
+

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

@@ -9,7 +9,7 @@ Given a component, finds the root XComponent in the ancestors hierarchy.
 <b>Signature:</b>
 
 ```typescript
-export declare function getRootXComponent(component: Vue): XComponent | undefined;
+export declare function getRootXComponent(component: Vue): Vue | undefined;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ export declare function getRootXComponent(component: Vue): XComponent | undefine
 
 <b>Returns:</b>
 
-[XComponent](./x-components.xcomponent.md) \| undefined
+Vue \| undefined
 
 The root XComponent or undefined if it has not.
 

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

@@ -9,7 +9,7 @@ Returns if the component is an X-Component. An X-Component is a component that h
 <b>Signature:</b>
 
 ```typescript
-export declare function isXComponent(component: Vue): component is XComponent;
+export declare function isXComponent(component: Vue): boolean;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ export declare function isXComponent(component: Vue): component is XComponent;
 
 <b>Returns:</b>
 
-component is [XComponent](./x-components.xcomponent.md)
+boolean
 
 A boolean which flags if a component is a X-Component.
 

package/docs/API-reference/api/x-components.maybearray.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; [MaybeArray](./x-components.maybearray.md)
+
+## MaybeArray type
+
+Alias for a type that might be an array or not.
+
+<b>Signature:</b>
+
+```typescript
+export declare type MaybeArray<Something> = Something | Array<Something>;
+```

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

@@ -71,6 +71,7 @@ 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. |
@@ -152,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\[\]. |
@@ -185,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. |
@@ -316,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. |
@@ -329,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. |
@@ -532,7 +533,9 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [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) |  |
@@ -598,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. |
@@ -653,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. |

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