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

package/CHANGELOG.md

@@ -3,6 +3,138 @@
 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
+
+- **search-box:** focus search input after clicking clear search button
+  ([d28994c](https://github.com/empathyco/x/commit/d28994c1995834a1adb19798060051089200d7f7)),
+  closes [EX-2242](https://searchbroker.atlassian.net/browse/EX-2242)
+- **tagging:** move `origin` from `request.getter` to `fetchAndSave.action`
+  ([b0bb40d](https://github.com/empathyco/x/commit/b0bb40de5e2ae7f65e2e2df032a1da9a51f0cb4d)),
+  closes [EX-5079](https://searchbroker.atlassian.net/browse/EX-5079)
+- **url:** set `origin` when navigating
+  ([02aa766](https://github.com/empathyco/x/commit/02aa7661a15c3718f4809d094a01b0f684a1f55d)),
+  closes [EX-3541](https://searchbroker.atlassian.net/browse/EX-3541)
+
+### Documentation
+
+- Remove docusaurus headers
+  ([6252165](https://github.com/empathyco/x/commit/62521658374eb5c78112314502606e2d82113a95)),
+  closes [EX-5081](https://searchbroker.atlassian.net/browse/EX-5081)
+
+# 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.33](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.32...@empathyco/x-components@3.0.0-alpha.33) (2021-11-30)
+
+### Features
+
+- **related-tags:** add `isCurated` property to related tags
+  ([e063f45](https://github.com/empathyco/x/commit/e063f4560573bcb1bf32fbe49753f2fe6b235cc7)),
+  closes [EX-4940](https://searchbroker.atlassian.net/browse/EX-4940)
+- **search:** change `saveOriginWire` wire from `SelectedRelatedTagsChanged` to
+  `UserPickedARelatedTag` (#254)
+  ([86072b0](https://github.com/empathyco/x/commit/86072b0805a3dc61b75c0a5760cf2c70e125be34)),
+  closes [EX-5078](https://searchbroker.atlassian.net/browse/EX-5078)
+- **utils:** now `origin` only requires the `feature`
+  ([087d646](https://github.com/empathyco/x/commit/087d646a2b97f945e9c4f81112925a6783d66f41)),
+  closes [EX-5077](https://searchbroker.atlassian.net/browse/EX-5077)
+
+# 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.32](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.31...@empathyco/x-components@3.0.0-alpha.32) (2021-11-29)
+
+### ⚠ BREAKING CHANGES
+
+- **storage-service:** `StorageService` has been renamed to `BrowserStorageService`.
+
+### Features
+
+- **components:** Add `GlobalXBus `component
+  ([cc8e28b](https://github.com/empathyco/x/commit/cc8e28b5b5d7f1735c490c0b576d620f4f1dd103)),
+  closes [EX-3535](https://searchbroker.atlassian.net/browse/EX-3535)
+- **components:** add `SnippetCallbacks` component
+  ([0b89a9f](https://github.com/empathyco/x/commit/0b89a9ff0de60194567d47e768bf0f0fb654b998)),
+  closes [EX-5002](https://searchbroker.atlassian.net/browse/EX-5002)
+- **storage-service:** Rename `StorageService` to `BrowserStorageService`
+  ([6bf38fb](https://github.com/empathyco/x/commit/6bf38fb7d14323c84c949e21eaa9c692fb0014d7)),
+  closes [EX-5073](https://searchbroker.atlassian.net/browse/EX-5073)
+
+### Bug Fixes
+
+- **tagging:** now removing the session clears the session from the storage
+  ([9328aad](https://github.com/empathyco/x/commit/9328aadca920825bdaddeb565ee47ef0430f25fd)),
+  closes [EX-5074](https://searchbroker.atlassian.net/browse/EX-5074)
+
+### Build System
+
+- update jest dependencies
+  ([f3fee15](https://github.com/empathyco/x/commit/f3fee157d724292f5cbb7166908d48ef2fb4fe8c)),
+  closes [EX-5027](https://searchbroker.atlassian.net/browse/EX-5027)
+
+# 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.31](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.30...@empathyco/x-components@3.0.0-alpha.31) (2021-11-25)
 
 ### 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';
@@ -77,21 +77,40 @@ export { default as PlusIcon } from '../js/components/icons/plus.vue.js';
 export { default as SearchIcon } from '../js/components/icons/search.vue.js';
 export { default as ShowIcon } from '../js/components/icons/show.vue.js';
 export { default as SearchTinyIcon } from '../js/components/icons/search-tiny.vue.js';
+export { default as TagIcon } from '../js/components/icons/tag.vue.js';
 export { default as TrashOpenIcon } from '../js/components/icons/trash-open.vue.js';
 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';
@@ -100,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';
@@ -113,22 +130,9 @@ 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';
 export { ItemsListInjectionMixin } from '../js/components/items-list-injection.mixin.js';
 export { infiniteScroll } from '../js/directives/infinite-scroll/infinite-scroll.js';
 export { compileMessage } from '../js/filters/compile-message.filter.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-adapter.empathyrelatedtag.md

@@ -17,5 +17,6 @@ export interface EmpathyRelatedTag
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [query](./x-adapter.empathyrelatedtag.query.md) | string |  |
+|  [source?](./x-adapter.empathyrelatedtag.source.md) | 'CURATED' \| 'ORGANIC' \| 'ENRICHED' | <i>(Optional)</i> |
 |  [tag](./x-adapter.empathyrelatedtag.tag.md) | string |  |
 

package/docs/API-reference/api/x-adapter.empathyrelatedtag.source.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter](./x-adapter.md) &gt; [EmpathyRelatedTag](./x-adapter.empathyrelatedtag.md) &gt; [source](./x-adapter.empathyrelatedtag.source.md)
+
+## EmpathyRelatedTag.source property
+
+<b>Signature:</b>
+
+```typescript
+source?: 'CURATED' | 'ORGANIC' | 'ENRICHED';
+```

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.defaultsessionservice.clearsessionid.md

@@ -4,6 +4,8 @@
 
 ## DefaultSessionService.clearSessionId() method
 
+Removes the session if from the storage.
+
 <b>Signature:</b>
 
 ```typescript

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

@@ -4,6 +4,8 @@
 
 ## DefaultSessionService.getSessionId() method
 
+Returns the session id of the storage.
+
 <b>Signature:</b>
 
 ```typescript
@@ -13,3 +15,5 @@ getSessionId(): string;
 
 string
 
+The current session id.
+

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

@@ -24,7 +24,7 @@ export declare class DefaultSessionService implements SessionService
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [instance](./x-components.defaultsessionservice.instance.md) | <code>static</code> | [SessionService](./x-components.sessionservice.md) | Global instance of the [SessionService](./x-components.sessionservice.md)<!-- -->. |
-|  [SESSION\_ID\_KEY](./x-components.defaultsessionservice.session_id_key.md) |  | (not declared) |  |
+|  [SESSION\_ID\_KEY](./x-components.defaultsessionservice.session_id_key.md) | <code>static</code> | (not declared) | Session id key to use as key in the storage. |
 |  [storageService](./x-components.defaultsessionservice.storageservice.md) |  | StorageService |  |
 |  [ttlMs](./x-components.defaultsessionservice.ttlms.md) |  | number |  |
 
@@ -32,6 +32,6 @@ export declare class DefaultSessionService implements SessionService
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [clearSessionId()](./x-components.defaultsessionservice.clearsessionid.md) |  |  |
-|  [getSessionId()](./x-components.defaultsessionservice.getsessionid.md) |  |  |
+|  [clearSessionId()](./x-components.defaultsessionservice.clearsessionid.md) |  | Removes the session if from the storage. |
+|  [getSessionId()](./x-components.defaultsessionservice.getsessionid.md) |  | Returns the session id of the storage. |
 

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

@@ -4,8 +4,10 @@
 
 ## DefaultSessionService.SESSION\_ID\_KEY property
 
+Session id key to use as key in the storage.
+
 <b>Signature:</b>
 
 ```typescript
-protected readonly SESSION_ID_KEY = "session-id";
+static readonly SESSION_ID_KEY = "session-id";
 ```

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

@@ -9,7 +9,7 @@ Indicates where the feature is placed.
 <b>Signature:</b>
 
 ```typescript
-export declare type FeatureLocation = 'external' | 'no_query' | 'no_results' | 'predictive_layer' | 'results' | 'pdp' | 'url_history' | 'url_history_pdp';
+export declare type FeatureLocation = 'external' | 'no_query' | 'no_results' | 'none' | 'predictive_layer' | 'results' | 'pdp' | 'url_history' | 'url_history_pdp';
 ```
 
 ## Example 1

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.globalxbus.created.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; [GlobalXBus](./x-components.globalxbus.md) &gt; [created](./x-components.globalxbus.created.md)
+
+## GlobalXBus.created() method
+
+<b>Signature:</b>
+
+```typescript
+created(): void;
+```
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.globalxbus.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; [GlobalXBus](./x-components.globalxbus.md)
+
+## GlobalXBus class
+
+This component helps subscribing to any [XEvent](./x-components.xevent.md) with custom callbacks using Vue listeners API.
+
+<b>Signature:</b>
+
+```typescript
+export default class GlobalXBus extends NoElement 
+```
+<b>Extends:</b> NoElement
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [created()](./x-components.globalxbus.created.md) |  |  |
+

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