@empathyco/x-components 3.0.0-alpha.39 → 3.0.0-alpha.40

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 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.40](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.39...@empathyco/x-components@3.0.0-alpha.40) (2021-12-29)
+
+### Features
+
+- **tagging:** add new `SearchTaggingReceived` event for tracking the query
+  ([d58b697](https://github.com/empathyco/x/commit/d58b69730915ccd6fb2b0656ff7280450275b5be)),
+  closes [EX-5170](https://searchbroker.atlassian.net/browse/EX-5170)
+
+### Bug Fixes
+
+- **components:** `SlidingPanel` can now disable the resetting scroll … (#286)
+  ([788eb18](https://github.com/empathyco/x/commit/788eb18bf0e066d932484143d0412497f3dada6e)),
+  closes [EX-5197](https://searchbroker.atlassian.net/browse/EX-5197)
+- **related-tags:** clear selected related tags when user changes extra params
+  ([b2d9b94](https://github.com/empathyco/x/commit/b2d9b94053aebbbda41659dbc3e4602931fd1bb5)),
+  closes [EX-5188](https://searchbroker.atlassian.net/browse/EX-5188)
+- **search:** batch state reset calls after a search.request parameter changes (#283)
+  ([492e856](https://github.com/empathyco/x/commit/492e8566913428426459ada29ca4963730cfcd7c)),
+  closes [EX-5057](https://searchbroker.atlassian.net/browse/EX-5057)
+- **search:** next page is now requested if it has less than the page size results. (#284)
+  ([f574792](https://github.com/empathyco/x/commit/f5747923f60f81564ebf124d95cae8a5d92400d4)),
+  closes [EX-5194](https://searchbroker.atlassian.net/browse/EX-5194)
+
+# 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.39](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.38...@empathyco/x-components@3.0.0-alpha.39) (2021-12-22)
 
 ### Features

package/core/index.js

@@ -16,7 +16,7 @@ export { getURLParameter } from '../js/utils/get-url-parameters.js';
 export { isElementEqualOrContained } from '../js/utils/html.js';
 export { normalizeString } from '../js/utils/normalize.js';
 export { isInRange } from '../js/utils/number.js';
-export { cleanUndefined, forEach, map, objectFilter, reduce } from '../js/utils/object.js';
+export { cleanUndefined, forEach, getNewAndUpdatedKeys, map, objectFilter, reduce } from '../js/utils/object.js';
 export { createOrigin } from '../js/utils/origin.js';
 export { sanitize } from '../js/utils/sanitize.js';
 export { localStorageService } from '../js/utils/storage.js';

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

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

package/docs/API-reference/api/x-adapter.empathynextquery.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; [EmpathyNextQuery](./x-adapter.empathynextquery.md) &gt; [source](./x-adapter.empathynextquery.source.md)
+
+## EmpathyNextQuery.source property
+
+<b>Signature:</b>
+
+```typescript
+source?: 'CURATED' | 'ORGANIC' | 'ENRICHED';
+```

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

@@ -9,5 +9,5 @@ Cancels the [SearchActions.fetchAndSaveSearchResponse()](./x-components.searchac
 <b>Signature:</b>
 
 ```typescript
-cancelFetchAndSaveSearchResponseWire: import("../..").AnyWire
+cancelFetchAndSaveSearchResponseWire: import("../../wiring/wiring.types").AnyWire
 ```

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

@@ -9,5 +9,5 @@ Requests and stores the search response.
 <b>Signature:</b>
 
 ```typescript
-fetchAndSaveSearchResponseWire: import("../..").Wire<import("./types").InternalSearchRequest | null>
+fetchAndSaveSearchResponseWire: import("../../wiring/wiring.types").Wire<InternalSearchRequest | null>
 ```

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [getNewAndUpdatedKeys](./x-components.getnewandupdatedkeys.md)
+
+## getNewAndUpdatedKeys() function
+
+Compares two objects of the same type, checking the values of their keys and retrieving those that were not present in the old value and/or those whose value has changed.
+
+<b>Signature:</b>
+
+```typescript
+export declare function getNewAndUpdatedKeys<ObjectType extends Dictionary>(newValue: ObjectType | undefined, oldValue: ObjectType | undefined): (keyof ObjectType)[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  newValue | ObjectType \| undefined | The new object value. |
+|  oldValue | ObjectType \| undefined | The old object value. |
+
+<b>Returns:</b>
+
+(keyof ObjectType)\[\]
+
+An array of keys.
+

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

@@ -9,5 +9,5 @@ Increases the current search state `page` by one.
 <b>Signature:</b>
 
 ```typescript
-increasePageAppendingResults: import("../..").AnyWire
+increasePageAppendingResults: import("../../wiring/wiring.types").AnyWire
 ```

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

@@ -106,7 +106,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [RenderlessExtraParams](./x-components.renderlessextraparams.md) | It emits a [ExtraParamsXEvents.UserChangedExtraParams](./x-components.extraparamsxevents.userchangedextraparams.md) when the <code>updateValue</code> is called. |
 |  [RenderlessFilter](./x-components.renderlessfilter.md) | Renders default slot content. It binds to the default slot a [BooleanFilter](./x-types.booleanfilter.md)<!-- -->, the [XEvents](./x-components.xevent.md) that will be emitted when clicking the content, the css classes and if the content should be disabled. |
 |  [ResultsList](./x-components.resultslist.md) | It renders a [ItemsList](./x-components.itemslist.md) list with the results from [SearchState.results](./x-components.searchstate.results.md) by default.<!-- -->The component provides a default slot which wraps the whole component with the <code>results</code> bound.<!-- -->It also provides the slot result to customize the item, which is within the default slot, with the result bound. |
-|  [Scroll](./x-components.scroll.md) | Base scroll component that depending on base scroll component and the user interaction emits different x events for knowing when the user scrolls, the direction of scroll and if user reaches the start or end. |
+|  [Scroll](./x-components.scroll.md) | Scrollable container that emits scroll related X Events. It exposes all the listeners and props from the [BaseScroll](./x-components.basescroll.md) component. |
 |  [ScrollMixin](./x-components.scrollmixin.md) | Mixin to share Scroll logic. |
 |  [ScrollToTop](./x-components.scrolltotop.md) | The <code>ScrollToTop</code> component is a button that the user can click to make a container scroll up to its initial position. |
 |  [SearchButton](./x-components.searchbutton.md) | This component renders a button to submit the query. |
@@ -116,7 +116,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [SimpleFilter](./x-components.simplefilter.md) | Renders a simple filter, emitting the needed events when clicked. |
 |  [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. |
+|  [SlidingPanel](./x-components.slidingpanel.md) | This component allows for any other component or element inside it to be horizontally navigable. It also implements customizable buttons as well as other minor customizations to its general behavior. |
 |  [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. |
@@ -163,6 +163,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [filterTruthyPayload(wire)](./x-components.filtertruthypayload.md) | Creates a [Wire](./x-components.wire.md) that is only executed when the payload is a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->. |
 |  [filterWhitelistedModules(wire, whitelist)](./x-components.filterwhitelistedmodules.md) | Creates a [Wire](./x-components.wire.md) that is only executed if the event is emitted from a [XModule](./x-components.xmodule.md) that is included in the <code>whitelist</code> array passed as parameter. |
 |  [forEach(obj, callbackFn)](./x-components.foreach.md) | Iterates over every non-undefined property of the object calling the callback passed as parameter. |
+|  [getNewAndUpdatedKeys(newValue, oldValue)](./x-components.getnewandupdatedkeys.md) | Compares two objects of the same type, checking the values of their keys and retrieving those that were not present in the old value and/or those whose value has changed. |
 |  [getRootXComponent(component)](./x-components.getrootxcomponent.md) | Given a component, finds the root XComponent in the ancestors hierarchy. |
 |  [getStateAndGettersFromModule(state, getters, moduleName)](./x-components.getstateandgettersfrommodule.md) | Returns an object with the getters and state of a module of store defined by the moduleName parameter. |
 |  [Getter(module, getter)](./x-components.getter.md) | Generates a computed property which returns the selected getter value.<!-- -->The decorated property needs to be public for type inference to work. |
@@ -324,6 +325,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [UrlMutations](./x-components.urlmutations.md) | URL store mutations. |
 |  [UrlParams](./x-components.urlparams.md) | URL store params. |
 |  [UrlXEvents](./x-components.urlxevents.md) | Dictionary of the events of URL 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. |
+|  [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) | A representation of a watched [InternalSearchRequest](./x-components.internalsearchrequest.md) object, wrapping its new and old values. |
 |  [WireMetadata](./x-components.wiremetadata.md) | The wires metadata includes more information about the emitted event, so then these events can be processed with more precision if needed. |
 |  [WireParams](./x-components.wireparams.md) | Groups the payload, metadata, and the store into an object to avoid having multiple parameters. |
 |  [WirePayload](./x-components.wirepayload.md) | The wire payload includes the payload of the event, and a [WireMetadata](./x-components.wiremetadata.md) object to add more information to the event. |
@@ -463,10 +465,8 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [removeFromHistory](./x-components.removefromhistory.md) | Default implementation for the [HistoryQueriesActions.removeFromHistory()](./x-components.historyqueriesactions.removefromhistory.md)<!-- -->. |
 |  [removeHistoryQuery](./x-components.removehistoryquery.md) | Removes a single history query from the history queries. |
 |  [resetAppending](./x-components.resetappending.md) | Resets the search state <code>isAppendingResults</code>. |
-|  [resetFacets](./x-components.resetfacets.md) | Sets empty value to the search state <code>facets</code>. |
-|  [resetPage](./x-components.resetpage.md) | Sets 1 to the search state <code>page</code>. |
-|  [resetSort](./x-components.resetsort.md) | Sets empty value to the search state <code>sort</code>. |
 |  [resetSpellcheckQuery](./x-components.resetspellcheckquery.md) | Resets the search state <code>spellcheckedQuery</code> to its initial value, an empty string. |
+|  [resetStateWire](./x-components.resetstatewire.md) | Batches state resets after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update. |
 |  [sanitize](./x-components.sanitize.md) | Sanitize characters from a given string. |
 |  [saveIdentifierResultsOriginWire](./x-components.saveidentifierresultsoriginwire.md) | Sets the identifier results state <code>origin</code>. |
 |  [saveOrigin](./x-components.saveorigin.md) | Default implementation for the [IdentifierResultsActions.saveOrigin()](./x-components.identifierresultsactions.saveorigin.md)<!-- -->. |
@@ -500,6 +500,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [setQuerySuggestionsExtraParams](./x-components.setquerysuggestionsextraparams.md) | Sets the query suggestions state <code>params</code>. |
 |  [setQuerySuggestionsQuery](./x-components.setquerysuggestionsquery.md) | Sets the query-suggestions module query. |
 |  [setQueryTaggingDebounce](./x-components.setquerytaggingdebounce.md) | Sets the tagging state config <code>queryTaggingDebounceMs</code>. |
+|  [setQueryTaggingInfo](./x-components.setquerytagginginfo.md) | Sets the tagging state of the query tagging info using a debounce which ends if the user accepts a query. |
 |  [setRecommendationsExtraParams](./x-components.setrecommendationsextraparams.md) | Sets the recommendations state <code>params</code>. |
 |  [setRelatedTags](./x-components.setrelatedtags.md) | Sets the search state <code>relatedTags</code>. |
 |  [setRelatedTagsExtraParams](./x-components.setrelatedtagsextraparams.md) | Sets the related tags state <code>params</code>. |
@@ -535,7 +536,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [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)<!-- -->. |
 |  [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. |
+|  [trackQueryWire](./x-components.trackquerywire.md) | Tracks the tagging of the query. |
 |  [trackResultClickedWire](./x-components.trackresultclickedwire.md) | Tracks the tagging of the result. |
 |  [TrashIcon](./x-components.trashicon.md) |  |
 |  [TrashOpenIcon](./x-components.trashopenicon.md) |  |

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

@@ -9,5 +9,5 @@ Resets the search state `isAppendingResults`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-resetAppending: import("../..").AnyWire
+resetAppending: import("../../wiring/wiring.types").AnyWire
 ```

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

@@ -9,5 +9,5 @@ Resets the search state `spellcheckedQuery` to its initial value, an empty strin
 <b>Signature:</b>
 
 ```typescript
-resetSpellcheckQuery: import("../..").AnyWire
+resetSpellcheckQuery: import("../../wiring/wiring.types").AnyWire
 ```

package/docs/API-reference/api/x-components.resetstatewire.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; [resetStateWire](./x-components.resetstatewire.md)
+
+## resetStateWire variable
+
+Batches state resets after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update.
+
+<b>Signature:</b>
+
+```typescript
+resetStateWire: import("../../wiring/wiring.types").AnyWire
+```

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

@@ -9,5 +9,5 @@ Sets the search state `origin`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-saveOriginWire: import("../..").AnyWire
+saveOriginWire: import("../../wiring/wiring.types").AnyWire
 ```

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

@@ -4,7 +4,7 @@
 
 ## Scroll class
 
-Base scroll component that depending on base scroll component and the user interaction emits different x events for knowing when the user scrolls, the direction of scroll and if user reaches the start or end.
+Scrollable container that emits scroll related X Events. It exposes all the listeners and props from the [BaseScroll](./x-components.basescroll.md) component.
 
 <b>Signature:</b>
 
@@ -17,7 +17,5 @@ export default class Scroll extends Vue
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [distanceToBottom](./x-components.scroll.distancetobottom.md) |  | number | Distance to the end of the scroll that when reached will emit the <code>scroll:about-to-end</code> event. |
 |  [id](./x-components.scroll.id.md) |  | string | Id to identify the component. |
-|  [throttleMs](./x-components.scroll.throttlems.md) |  | number | Time duration to ignore the subsequent scroll events after an emission. Higher values will decrease events precision but can prevent performance issues. |
 

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

@@ -20,6 +20,7 @@ export default class ScrollMixin extends Vue
 |  [$el](./x-components.scrollmixin._el.md) |  | HTMLElement | The scrolling container reference. |
 |  [distanceToBottom](./x-components.scrollmixin.distancetobottom.md) |  | number | Distance to the end of the scroll that when reached will emit the <code>scroll:about-to-end</code> event. |
 |  [firstElementThresholdPx](./x-components.scrollmixin.firstelementthresholdpx.md) |  | number | Positive vertical distance to still consider that the an element is the first one visible. For example, if set to 100, after scrolling 100 pixels, the first rendered element will still be considered the first one. |
+|  [resetOn](./x-components.scrollmixin.reseton.md) |  | [XEvent](./x-components.xevent.md) | List of events that should reset the scroll when emitted. |
 |  [resetOnChange](./x-components.scrollmixin.resetonchange.md) |  | boolean | If true (default), sets the scroll position to the top when certain events are emitted. |
 |  [throttleMs](./x-components.scrollmixin.throttlems.md) |  | number | Time duration to ignore the subsequent scroll events after an emission. Higher values will decrease events precision but can prevent performance issues. |
 

package/docs/API-reference/api/x-components.scrollmixin.reseton.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; [ScrollMixin](./x-components.scrollmixin.md) &gt; [resetOn](./x-components.scrollmixin.reseton.md)
+
+## ScrollMixin.resetOn property
+
+List of events that should reset the scroll when emitted.
+
+<b>Signature:</b>
+
+```typescript
+resetOn: XEvent;
+```

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

@@ -20,6 +20,7 @@ export interface SearchActions
 |  [fetchAndSaveSearchResponse(request)](./x-components.searchactions.fetchandsavesearchresponse.md) | Fetches a new search response and stores them in the module state. |
 |  [fetchSearchResponse(request)](./x-components.searchactions.fetchsearchresponse.md) | Fetches the search response and returns them. |
 |  [increasePageAppendingResults()](./x-components.searchactions.increasepageappendingresults.md) | Checks if there are more pages of results to load. If there are, then increases the page number in state and set to <code>true</code> the [SearchState.isAppendResults](./x-components.searchstate.isappendresults.md) flag. |
+|  [resetState(watchedRequest)](./x-components.searchactions.resetstate.md) | Batches state resets in a single action after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update. |
 |  [saveOrigin(originInit)](./x-components.searchactions.saveorigin.md) | Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it. |
 |  [setUrlParams(urlParams)](./x-components.searchactions.seturlparams.md) | Checks if the url has params on it and then updates the state with these values. |
 

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SearchActions](./x-components.searchactions.md) &gt; [resetState](./x-components.searchactions.resetstate.md)
+
+## SearchActions.resetState() method
+
+Batches state resets in a single action after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update.
+
+<b>Signature:</b>
+
+```typescript
+resetState(watchedRequest: WatchedInternalSearchRequest): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  watchedRequest | [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) | The watched internal search request object. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -20,6 +20,7 @@ export interface SearchXEvents
 |  [PageChanged](./x-components.searchxevents.pagechanged.md) | number | Page has been changed. \* Payload: The new page number. |
 |  [ResultsChanged](./x-components.searchxevents.resultschanged.md) | Result\[\] | Results have been changed. \* Payload: The new [results](./x-types.result.md)<!-- -->. |
 |  [SearchRequestChanged](./x-components.searchxevents.searchrequestchanged.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) \| null | Any property of the search request has changed. \* Payload: The new search request or <code>null</code> if there is not enough data in the state to conform a valid request. |
+|  [SearchRequestUpdated](./x-components.searchxevents.searchrequestupdated.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) | Any property of the search request has been updated. \* Payload: The new internal request object. |
 |  [SearchTaggingChanged](./x-components.searchxevents.searchtaggingchanged.md) | TaggingInfo | Query tagging has been changed. \* Payload: The new query tagging object. |
 |  [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. |

package/docs/API-reference/api/x-components.searchxevents.searchrequestupdated.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; [SearchRequestUpdated](./x-components.searchxevents.searchrequestupdated.md)
+
+## SearchXEvents.SearchRequestUpdated property
+
+Any property of the search request has been updated. \* Payload: The new internal request object.
+
+<b>Signature:</b>
+
+```typescript
+SearchRequestUpdated: InternalSearchRequest;
+```

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

@@ -9,5 +9,5 @@ Sets the search state `pageSize`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setPageSize: import("../..").Wire<number>
+setPageSize: import("../../wiring/wiring.types").Wire<number>
 ```

package/docs/API-reference/api/x-components.setquerytagginginfo.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; [setQueryTaggingInfo](./x-components.setquerytagginginfo.md)
+
+## setQueryTaggingInfo variable
+
+Sets the tagging state of the query tagging info using a debounce which ends if the user accepts a query.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTaggingInfo: Wire<TaggingInfo>
+```

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

@@ -9,5 +9,5 @@ Sets the search state `relatedTags`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setRelatedTags: import("../..").Wire<import("@empathyco/x-types").RelatedTag[]>
+setRelatedTags: import("../../wiring/wiring.types").Wire<import("@empathyco/x-types").RelatedTag[]>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `params`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSearchExtraParams: import("../..").Wire<import("../..").Dictionary<unknown>>
+setSearchExtraParams: import("../../wiring/wiring.types").Wire<import("../..").Dictionary<unknown>>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `page`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSearchPage: import("../..").Wire<number>
+setSearchPage: import("../../wiring/wiring.types").Wire<number>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `query`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSearchQuery: import("../..").Wire<string>
+setSearchQuery: import("../../wiring/wiring.types").Wire<string>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `selectedFilters`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSelectedFilters: import("../..").Wire<import("@empathyco/x-types").Filter[]>
+setSelectedFilters: import("../../wiring/wiring.types").Wire<import("@empathyco/x-types").Filter[]>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `sort`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setSort: import("../..").Wire<string>
+setSort: import("../../wiring/wiring.types").Wire<string>
 ```

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

@@ -9,5 +9,5 @@ Sets the search state `query`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-setUrlParams: import("../..").Wire<import("../..").UrlParams>
+setUrlParams: import("../../wiring/wiring.types").Wire<import("../..").UrlParams>
 ```

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

@@ -4,7 +4,7 @@
 
 ## SlidingPanel class
 
-Horizontal slide panel component. The content that is provided to this component would be navigable horizontally using two navigational buttons.
+This component allows for any other component or element inside it to be horizontally navigable. It also implements customizable buttons as well as other minor customizations to its general behavior.
 
 <b>Signature:</b>
 
@@ -17,17 +17,7 @@ export default class SlidingPanel extends Vue
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [$refs](./x-components.slidingpanel._refs.md) |  | { scrollContainer: HTMLElement; } | HTMLElement referencing the scroll of the component. |
-|  [isScrollAtEnd](./x-components.slidingpanel.isscrollatend.md) |  | boolean | Indicates if the scroll is at the end of the sliding panel. |
-|  [isScrollAtStart](./x-components.slidingpanel.isscrollatstart.md) |  | boolean | Indicates if the scroll is at the start of the sliding panel. |
+|  [resetOnContentChange](./x-components.slidingpanel.resetoncontentchange.md) |  | boolean | When true, whenever the DOM content in the sliding panel slot changes, it will reset the scroll position to 0. |
 |  [scrollFactor](./x-components.slidingpanel.scrollfactor.md) |  | number | Scroll factor that will dictate how much the scroll moves when pressing a navigation button. |
-|  [scrollObserver](./x-components.slidingpanel.scrollobserver.md) |  | MutationObserver | MutationObserver that watches for changes inside the wrapping div to update the scroll position. |
 |  [showButtons](./x-components.slidingpanel.showbuttons.md) |  | boolean | Would make the navigation buttons visible when they're needed or always hide them. |
 
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [beforeDestroy()](./x-components.slidingpanel.beforedestroy.md) |  |  |
-|  [mounted()](./x-components.slidingpanel.mounted.md) |  |  |
-

package/docs/API-reference/api/x-components.slidingpanel.resetoncontentchange.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; [SlidingPanel](./x-components.slidingpanel.md) &gt; [resetOnContentChange](./x-components.slidingpanel.resetoncontentchange.md)
+
+## SlidingPanel.resetOnContentChange property
+
+When true, whenever the DOM content in the sliding panel slot changes, it will reset the scroll position to 0.
+
+<b>Signature:</b>
+
+```typescript
+resetOnContentChange: boolean;
+```

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

@@ -9,5 +9,5 @@ Scroll factor that will dictate how much the scroll moves when pressing a naviga
 <b>Signature:</b>
 
 ```typescript
-protected scrollFactor: number;
+scrollFactor: number;
 ```

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

@@ -9,5 +9,5 @@ Would make the navigation buttons visible when they're needed or always hide the
 <b>Signature:</b>
 
 ```typescript
-protected showButtons: boolean;
+showButtons: boolean;
 ```

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

@@ -18,5 +18,6 @@ export interface TaggingMutations
 |  --- | --- |
 |  [setConsent(consent)](./x-components.taggingmutations.setconsent.md) | Sets the [TaggingState.consent](./x-components.taggingstate.consent.md) property. |
 |  [setQueryTaggingDebounce(queryTaggingDebounceMs)](./x-components.taggingmutations.setquerytaggingdebounce.md) | Sets the [TaggingConfig.queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md) property. |
+|  [setQueryTaggingInfo(queryTaggingInfo)](./x-components.taggingmutations.setquerytagginginfo.md) | Sets the [TaggingState.queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md) property. |
 |  [setSessionDuration(sessionTTLMs)](./x-components.taggingmutations.setsessionduration.md) | Sets the [TaggingConfig.sessionTTLMs](./x-components.taggingconfig.sessionttlms.md) property. |
 

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TaggingMutations](./x-components.taggingmutations.md) &gt; [setQueryTaggingInfo](./x-components.taggingmutations.setquerytagginginfo.md)
+
+## TaggingMutations.setQueryTaggingInfo() method
+
+Sets the [TaggingState.queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md) property.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTaggingInfo(queryTaggingInfo: TaggingInfo): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  queryTaggingInfo | TaggingInfo | The new [TaggingState.queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md)<!-- -->. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -18,4 +18,5 @@ export interface TaggingState
 |  --- | --- | --- |
 |  [config](./x-components.taggingstate.config.md) | [TaggingConfig](./x-components.taggingconfig.md) | Configuration for the <code>Tagging</code> module. |
 |  [consent](./x-components.taggingstate.consent.md) | boolean \| null | The current consent for tracking. |
+|  [queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md) | TaggingInfo \| null | Tagging info for last accepted query. |
 

package/docs/API-reference/api/x-components.taggingstate.querytagginginfo.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; [TaggingState](./x-components.taggingstate.md) &gt; [queryTaggingInfo](./x-components.taggingstate.querytagginginfo.md)
+
+## TaggingState.queryTaggingInfo property
+
+Tagging info for last accepted query.
+
+<b>Signature:</b>
+
+```typescript
+queryTaggingInfo: TaggingInfo | null;
+```

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

@@ -19,5 +19,6 @@ export interface TaggingXEvents
 |  [ConsentChanged](./x-components.taggingxevents.consentchanged.md) | boolean | Consent has changed. \* Payload: The new consent value. |
 |  [ConsentProvided](./x-components.taggingxevents.consentprovided.md) | boolean | Consent has been provided. \* Payload: The new consent value. |
 |  [QueryTaggingDebounceProvided](./x-components.taggingxevents.querytaggingdebounceprovided.md) | number | Query tagging debounce has been provided. \* Payload: The new query tagging debounce value. |
+|  [SearchTaggingReceived](./x-components.taggingxevents.searchtaggingreceived.md) | TaggingInfo | Query tagging info has changed. \* Payload: The new query tagging info. |
 |  [SessionDurationProvided](./x-components.taggingxevents.sessiondurationprovided.md) | number | Session duration has been provided. \* Payload: The new session duration value. |
 

package/docs/API-reference/api/x-components.taggingxevents.searchtaggingreceived.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; [TaggingXEvents](./x-components.taggingxevents.md) &gt; [SearchTaggingReceived](./x-components.taggingxevents.searchtaggingreceived.md)
+
+## TaggingXEvents.SearchTaggingReceived property
+
+Query tagging info has changed. \* Payload: The new query tagging info.
+
+<b>Signature:</b>
+
+```typescript
+SearchTaggingReceived: TaggingInfo;
+```

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

@@ -4,7 +4,7 @@
 
 ## trackQueryWire variable
 
-Tracks the tagging of the query using a debounce which ends if the user accepts a query.
+Tracks the tagging of the query.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/x-components.watchedinternalsearchrequest.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; [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md)
+
+## WatchedInternalSearchRequest interface
+
+A representation of a watched [InternalSearchRequest](./x-components.internalsearchrequest.md) object, wrapping its new and old values.
+
+<b>Signature:</b>
+
+```typescript
+export interface WatchedInternalSearchRequest 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [newRequest](./x-components.watchedinternalsearchrequest.newrequest.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) |  |
+|  [oldRequest](./x-components.watchedinternalsearchrequest.oldrequest.md) | [InternalSearchRequest](./x-components.internalsearchrequest.md) |  |
+

package/docs/API-reference/api/x-components.watchedinternalsearchrequest.newrequest.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; [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) &gt; [newRequest](./x-components.watchedinternalsearchrequest.newrequest.md)
+
+## WatchedInternalSearchRequest.newRequest property
+
+<b>Signature:</b>
+
+```typescript
+newRequest: InternalSearchRequest;
+```

package/docs/API-reference/api/x-components.watchedinternalsearchrequest.oldrequest.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; [WatchedInternalSearchRequest](./x-components.watchedinternalsearchrequest.md) &gt; [oldRequest](./x-components.watchedinternalsearchrequest.oldrequest.md)
+
+## WatchedInternalSearchRequest.oldRequest property
+
+<b>Signature:</b>
+
+```typescript
+oldRequest: InternalSearchRequest;
+```