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

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

@@ -27,6 +27,7 @@ export interface SearchState extends StatusState
 |  [partialResults](./x-components.searchstate.partialresults.md) | PartialResult\[\] | The list of the partial results, related to the <code>query</code> property of the state. |
 |  [promoteds](./x-components.searchstate.promoteds.md) | Promoted\[\] | The list of the promoted, related to the <code>query</code> property of the state. |
 |  [query](./x-components.searchstate.query.md) | string | The internal query of the module. Used to request the search results. |
+|  [queryTagging](./x-components.searchstate.querytagging.md) | TaggingInfo | The query tagging used to track the search events. |
 |  [redirections](./x-components.searchstate.redirections.md) | Redirection\[\] | The redirections associated to the <code>query</code>. |
 |  [relatedTags](./x-components.searchstate.relatedtags.md) | RelatedTag\[\] | The list of the related tags, related to the <code>query</code> property of the state. |
 |  [results](./x-components.searchstate.results.md) | Result\[\] | The list of the results, related to the <code>query</code> property of the state. |

package/docs/API-reference/api/x-components.searchstate.querytagging.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; [SearchState](./x-components.searchstate.md) &gt; [queryTagging](./x-components.searchstate.querytagging.md)
+
+## SearchState.queryTagging property
+
+The query tagging used to track the search events.
+
+<b>Signature:</b>
+
+```typescript
+queryTagging: TaggingInfo;
+```

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) | SearchRequest \| 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. |
+|  [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. |
 |  [SpellcheckChanged](./x-components.searchxevents.spellcheckchanged.md) | string | Spellcheck has been changed. \* Payload: The new spellcheckedQuery string. |

package/docs/API-reference/api/x-components.searchxevents.searchtaggingchanged.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; [SearchTaggingChanged](./x-components.searchxevents.searchtaggingchanged.md)
+
+## SearchXEvents.SearchTaggingChanged property
+
+Query tagging has been changed. \* Payload: The new query tagging object.
+
+<b>Signature:</b>
+
+```typescript
+SearchTaggingChanged: TaggingInfo;
+```

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SessionService](./x-components.sessionservice.md) &gt; [clearSessionId](./x-components.sessionservice.clearsessionid.md)
+
+## SessionService.clearSessionId() method
+
+Remove the session id.
+
+<b>Signature:</b>
+
+```typescript
+clearSessionId(): void;
+```
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SessionService](./x-components.sessionservice.md) &gt; [getSessionId](./x-components.sessionservice.getsessionid.md)
+
+## SessionService.getSessionId() method
+
+Gets the current session id from the storage.
+
+<b>Signature:</b>
+
+```typescript
+getSessionId(): string;
+```
+<b>Returns:</b>
+
+string
+
+The session id.
+
+## Remarks
+
+If a session id is outdated or does not exist, a new one is created.
+

package/docs/API-reference/api/x-components.sessionservice.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; [SessionService](./x-components.sessionservice.md)
+
+## SessionService interface
+
+Service to manage the session id.
+
+<b>Signature:</b>
+
+```typescript
+export interface SessionService 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [clearSessionId()](./x-components.sessionservice.clearsessionid.md) | Remove the session id. |
+|  [getSessionId()](./x-components.sessionservice.getsessionid.md) | Gets the current session id from the storage. |
+

package/docs/API-reference/api/x-components.setconsent.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; [setConsent](./x-components.setconsent.md)
+
+## setConsent variable
+
+Sets the tagging state `consent`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+setConsent: import("../../wiring").Wire<boolean>
+```

package/docs/API-reference/api/x-components.setidentifierresultsextraparams.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; [setIdentifierResultsExtraParams](./x-components.setidentifierresultsextraparams.md)
+
+## setIdentifierResultsExtraParams variable
+
+Sets the identifier result state `params`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+setIdentifierResultsExtraParams: import("../..").Wire<import("../..").Dictionary<unknown>>
+```

package/docs/API-reference/api/x-components.setpendingscrolltowire.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; [setPendingScrollToWire](./x-components.setpendingscrolltowire.md)
+
+## setPendingScrollToWire variable
+
+Saves the selector of the item that should be scrolled into the view.
+
+<b>Signature:</b>
+
+```typescript
+setPendingScrollToWire: import("../../wiring/wiring.types").AnyWire
+```

package/docs/API-reference/api/x-components.setquerytaggingdebounce.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; [setQueryTaggingDebounce](./x-components.setquerytaggingdebounce.md)
+
+## setQueryTaggingDebounce variable
+
+Sets the tagging state config `queryTaggingDebounceMs`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTaggingDebounce: import("../../wiring").Wire<number>
+```

package/docs/API-reference/api/x-components.setscrolldirectionwire.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; [setScrollDirectionWire](./x-components.setscrolldirectionwire.md)
+
+## setScrollDirectionWire variable
+
+Saves the scroll direction of a container to the store.
+
+<b>Signature:</b>
+
+```typescript
+setScrollDirectionWire: import("../../wiring/wiring.types").AnyWire
+```

package/docs/API-reference/api/x-components.setscrollhasalmostreachedendwire.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; [setScrollHasAlmostReachedEndWire](./x-components.setscrollhasalmostreachedendwire.md)
+
+## setScrollHasAlmostReachedEndWire variable
+
+Saves a boolean indicating if the scroll has almost reached the end of a container to the store.
+
+<b>Signature:</b>
+
+```typescript
+setScrollHasAlmostReachedEndWire: import("../../wiring/wiring.types").AnyWire
+```

package/docs/API-reference/api/x-components.setscrollhasreachedendwire.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; [setScrollHasReachedEndWire](./x-components.setscrollhasreachedendwire.md)
+
+## setScrollHasReachedEndWire variable
+
+Saves a boolean indicating if the scroll has reached the end of a container to the store.
+
+<b>Signature:</b>
+
+```typescript
+setScrollHasReachedEndWire: import("../../wiring/wiring.types").AnyWire
+```

package/docs/API-reference/api/x-components.setscrollhasreachedstartwire.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; [setScrollHasReachedStartWire](./x-components.setscrollhasreachedstartwire.md)
+
+## setScrollHasReachedStartWire variable
+
+Saves a boolean indicating if the scroll has reached the start of a container to the store.
+
+<b>Signature:</b>
+
+```typescript
+setScrollHasReachedStartWire: import("../../wiring/wiring.types").AnyWire
+```

package/docs/API-reference/api/x-components.setscrollpositionwire.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; [setScrollPositionWire](./x-components.setscrollpositionwire.md)
+
+## setScrollPositionWire variable
+
+Saves the scroll position of a container to the store.
+
+<b>Signature:</b>
+
+```typescript
+setScrollPositionWire: import("../../wiring/wiring.types").AnyWire
+```

package/docs/API-reference/api/x-components.setsessionduration.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; [setSessionDuration](./x-components.setsessionduration.md)
+
+## setSessionDuration variable
+
+Sets the tagging state `sessionTTLMs`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+setSessionDuration: import("../../wiring").Wire<number>
+```

package/docs/API-reference/api/x-components.seturlscroll.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; [setUrlScroll](./x-components.seturlscroll.md)
+
+## setUrlScroll variable
+
+Sets the scroll of the url module.
+
+<b>Signature:</b>
+
+```typescript
+setUrlScroll: import("../..").Wire<string>
+```

package/docs/API-reference/api/x-components.seturlsort.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; [setUrlSort](./x-components.seturlsort.md)
+
+## setUrlSort variable
+
+Sets the sort of the url module.
+
+<b>Signature:</b>
+
+```typescript
+setUrlSort: import("../..").Wire<string>
+```

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

@@ -4,7 +4,7 @@
 
 ## SortMixin.items property
 
-The list of possible sort values. If the [SortMixin.value](./x-components.sortmixin.value.md) option is not provided, the first item of this list will be selected.
+The list of possible sort values. If there are no values selected, the first item of this list will be selected.
 
 <b>Signature:</b>
 

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

@@ -17,7 +17,6 @@ export default class SortMixin extends Vue
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [items](./x-components.sortmixin.items.md) |  | Sort\[\] | The list of possible sort values. If the [SortMixin.value](./x-components.sortmixin.value.md) option is not provided, the first item of this list will be selected. |
-|  [providedSelectedSort](./x-components.sortmixin.providedselectedsort.md) |  | Sort | Emits the [SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md) event whenever the provided [SortMixin.value](./x-components.sortmixin.value.md) changes. If no value is provided, the first item of the [SortMixin.items](./x-components.sortmixin.items.md) will be used as fallback. |
-|  [value?](./x-components.sortmixin.value.md) |  | Sort | <i>(Optional)</i> The selected sort value. This is an optional prop that allows to change programmatically the selected sort. If it is not provided, the first item of the [SortMixin.items](./x-components.sortmixin.items.md) list will be selected. |
+|  [items](./x-components.sortmixin.items.md) |  | Sort\[\] | The list of possible sort values. If there are no values selected, the first item of this list will be selected. |
+|  [providedSelectedSort](./x-components.sortmixin.providedselectedsort.md) |  | Sort | Emits the [SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md) event whenever the provided  changes. If no value is provided, the first item of the [SortMixin.items](./x-components.sortmixin.items.md) will be used as fallback. |
 

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

@@ -4,7 +4,7 @@
 
 ## SortMixin.providedSelectedSort property
 
-Emits the [SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md) event whenever the provided [SortMixin.value](./x-components.sortmixin.value.md) changes. If no value is provided, the first item of the [SortMixin.items](./x-components.sortmixin.items.md) will be used as fallback.
+Emits the [SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md) event whenever the provided  changes. If no value is provided, the first item of the [SortMixin.items](./x-components.sortmixin.items.md) will be used as fallback.
 
 <b>Signature:</b>
 

package/docs/API-reference/api/{x-components.spellcheckbutton.events.md → x-components.spellcheckbutton.emitevents.md}

@@ -1,13 +1,17 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SpellcheckButton](./x-components.spellcheckbutton.md) &gt; [events](./x-components.spellcheckbutton.events.md)
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SpellcheckButton](./x-components.spellcheckbutton.md) &gt; [emitEvents](./x-components.spellcheckbutton.emitevents.md)
 
-## SpellcheckButton.events property
+## SpellcheckButton.emitEvents() method
 
-Events list which are going to be emitted when the button is clicked.
+Emits events when the button is clicked.
 
 <b>Signature:</b>
 
 ```typescript
-protected get events(): Partial<XEventsTypes>;
+protected emitEvents(): void;
 ```
+<b>Returns:</b>
+
+void
+

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

@@ -17,6 +17,11 @@ export default class SpellcheckButton extends Vue
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [events](./x-components.spellcheckbutton.events.md) |  | Partial&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt; | Events list which are going to be emitted when the button is clicked. |
 |  [spellcheckedQuery](./x-components.spellcheckbutton.spellcheckedquery.md) |  | string | The spellcheckedQuery from the search state. |
 
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [emitEvents()](./x-components.spellcheckbutton.emitevents.md) |  | Emits events when the button is clicked. |
+

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

@@ -11,3 +11,10 @@ Tagging store actions.
 ```typescript
 export interface TaggingActions 
 ```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [track(tagging)](./x-components.taggingactions.track.md) | Tracks a user interaction. |
+

package/docs/API-reference/api/x-components.taggingactions.track.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; [TaggingActions](./x-components.taggingactions.md) &gt; [track](./x-components.taggingactions.track.md)
+
+## TaggingActions.track() method
+
+Tracks a user interaction.
+
+<b>Signature:</b>
+
+```typescript
+track(tagging: TaggingInfo | TaggingInfo[]): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tagging | TaggingInfo \| TaggingInfo\[\] | The information of the event to track. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -11,3 +11,11 @@ Configuration options for the [TaggingXModule](./x-components.taggingxmodule.md)
 ```typescript
 export interface TaggingConfig 
 ```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md) | number | Time in milliseconds to track the query. |
+|  [sessionTTLMs](./x-components.taggingconfig.sessionttlms.md) | number | Time in milliseconds to keep the session alive. After this time has passed with no user interaction, the session will be cleared. |
+

package/docs/API-reference/api/x-components.taggingconfig.querytaggingdebouncems.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; [TaggingConfig](./x-components.taggingconfig.md) &gt; [queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md)
+
+## TaggingConfig.queryTaggingDebounceMs property
+
+Time in milliseconds to track the query.
+
+<b>Signature:</b>
+
+```typescript
+queryTaggingDebounceMs: number;
+```

package/docs/API-reference/api/x-components.taggingconfig.sessionttlms.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; [TaggingConfig](./x-components.taggingconfig.md) &gt; [sessionTTLMs](./x-components.taggingconfig.sessionttlms.md)
+
+## TaggingConfig.sessionTTLMs property
+
+Time in milliseconds to keep the session alive. After this time has passed with no user interaction, the session will be cleared.
+
+<b>Signature:</b>
+
+```typescript
+sessionTTLMs: number;
+```

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

@@ -11,3 +11,12 @@ Tagging store mutations.
 ```typescript
 export interface TaggingMutations 
 ```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [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. |
+|  [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.setconsent.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; [setConsent](./x-components.taggingmutations.setconsent.md)
+
+## TaggingMutations.setConsent() method
+
+Sets the [TaggingState.consent](./x-components.taggingstate.consent.md) property.
+
+<b>Signature:</b>
+
+```typescript
+setConsent(consent: boolean): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  consent | boolean | The new [TaggingState.consent](./x-components.taggingstate.consent.md)<!-- -->. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.taggingmutations.setquerytaggingdebounce.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; [setQueryTaggingDebounce](./x-components.taggingmutations.setquerytaggingdebounce.md)
+
+## TaggingMutations.setQueryTaggingDebounce() method
+
+Sets the [TaggingConfig.queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md) property.
+
+<b>Signature:</b>
+
+```typescript
+setQueryTaggingDebounce(queryTaggingDebounceMs: number): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  queryTaggingDebounceMs | number | The new [TaggingConfig.queryTaggingDebounceMs](./x-components.taggingconfig.querytaggingdebouncems.md)<!-- -->. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.taggingmutations.setsessionduration.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; [setSessionDuration](./x-components.taggingmutations.setsessionduration.md)
+
+## TaggingMutations.setSessionDuration() method
+
+Sets the [TaggingConfig.sessionTTLMs](./x-components.taggingconfig.sessionttlms.md) property.
+
+<b>Signature:</b>
+
+```typescript
+setSessionDuration(sessionTTLMs: number): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sessionTTLMs | number | The new [TaggingConfig.sessionTTLMs](./x-components.taggingconfig.sessionttlms.md)<!-- -->. |
+
+<b>Returns:</b>
+
+void
+

package/docs/API-reference/api/x-components.taggingstate.config.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; [config](./x-components.taggingstate.config.md)
+
+## TaggingState.config property
+
+Configuration for the `Tagging` module.
+
+<b>Signature:</b>
+
+```typescript
+config: TaggingConfig;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [TaggingState](./x-components.taggingstate.md) &gt; [consent](./x-components.taggingstate.consent.md)
+
+## TaggingState.consent property
+
+The current consent for tracking.
+
+<b>Signature:</b>
+
+```typescript
+consent: boolean | null;
+```

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

@@ -11,3 +11,11 @@ Tagging store state.
 ```typescript
 export interface TaggingState 
 ```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [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. |
+

package/docs/API-reference/api/x-components.taggingxevents.consentchanged.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; [ConsentChanged](./x-components.taggingxevents.consentchanged.md)
+
+## TaggingXEvents.ConsentChanged property
+
+Consent has changed. \* Payload: The new consent value.
+
+<b>Signature:</b>
+
+```typescript
+ConsentChanged: boolean;
+```

package/docs/API-reference/api/x-components.taggingxevents.consentprovided.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; [ConsentProvided](./x-components.taggingxevents.consentprovided.md)
+
+## TaggingXEvents.ConsentProvided property
+
+Consent has been provided. \* Payload: The new consent value.
+
+<b>Signature:</b>
+
+```typescript
+ConsentProvided: boolean;
+```

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

@@ -11,3 +11,13 @@ Dictionary of the events of Tagging XModule, where each key is the event name, a
 ```typescript
 export interface TaggingXEvents 
 ```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [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. |
+|  [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.querytaggingdebounceprovided.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; [QueryTaggingDebounceProvided](./x-components.taggingxevents.querytaggingdebounceprovided.md)
+
+## TaggingXEvents.QueryTaggingDebounceProvided property
+
+Query tagging debounce has been provided. \* Payload: The new query tagging debounce value.
+
+<b>Signature:</b>
+
+```typescript
+QueryTaggingDebounceProvided: number;
+```