@empathyco/x-components 7.4.0 → 7.4.1

package/docs/API-reference/api/x-components.browsestate.promoteds.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; [BrowseState](./x-components.browsestate.md) &gt; [promoteds](./x-components.browsestate.promoteds.md)
+
+## BrowseState.promoteds property
+
+The list of the promoted, related to the `query` property of the state.
+
+**Signature:**
+
+```typescript
+promoteds: Promoted[];
+```

package/docs/API-reference/api/x-components.browsestate.results.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; [BrowseState](./x-components.browsestate.md) &gt; [results](./x-components.browsestate.results.md)
+
+## BrowseState.results property
+
+The list of the results, related to the `query` property of the state.
+
+**Signature:**
+
+```typescript
+results: Result[];
+```

package/docs/API-reference/api/x-components.browsestate.selectedcategory.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; [BrowseState](./x-components.browsestate.md) &gt; [selectedCategory](./x-components.browsestate.selectedcategory.md)
+
+## BrowseState.selectedCategory property
+
+The current selected category of the request
+
+**Signature:**
+
+```typescript
+selectedCategory: BrowsableRequest;
+```

package/docs/API-reference/api/x-components.browsestate.selectedfilters.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; [BrowseState](./x-components.browsestate.md) &gt; [selectedFilters](./x-components.browsestate.selectedfilters.md)
+
+## BrowseState.selectedFilters property
+
+The dictionary of selected filters, used to perform the browse request. The key is the facet id, and the value the list of filters for that facet.
+
+**Signature:**
+
+```typescript
+selectedFilters: Dictionary<Filter[]>;
+```

package/docs/API-reference/api/x-components.browsestate.sort.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; [BrowseState](./x-components.browsestate.md) &gt; [sort](./x-components.browsestate.sort.md)
+
+## BrowseState.sort property
+
+The way of ordering the results.
+
+**Signature:**
+
+```typescript
+sort: Sort;
+```

package/docs/API-reference/api/x-components.browsestate.stats.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; [BrowseState](./x-components.browsestate.md) &gt; [stats](./x-components.browsestate.stats.md)
+
+## BrowseState.stats property
+
+The stats of the results.
+
+**Signature:**
+
+```typescript
+stats: Stats;
+```

package/docs/API-reference/api/x-components.browsestate.totalresults.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; [BrowseState](./x-components.browsestate.md) &gt; [totalResults](./x-components.browsestate.totalresults.md)
+
+## BrowseState.totalResults property
+
+The total number of results, related to the `query` property of the state.
+
+**Signature:**
+
+```typescript
+totalResults: number;
+```

package/docs/API-reference/api/x-components.browsexevents.browserequestchanged.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; [BrowseXEvents](./x-components.browsexevents.md) &gt; [BrowseRequestChanged](./x-components.browsexevents.browserequestchanged.md)
+
+## BrowseXEvents.BrowseRequestChanged property
+
+Any property of the browse request has changed. Payload: The new browse request or `null` if there is not enough data in the state to conform a valid request.
+
+**Signature:**
+
+```typescript
+BrowseRequestChanged: InternalBrowseRequest | null;
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseXEvents](./x-components.browsexevents.md) &gt; [BrowseRequestUpdated](./x-components.browsexevents.browserequestupdated.md)
+
+## BrowseXEvents.BrowseRequestUpdated property
+
+Any property of the browse request has been updated. Payload: The new browse request or `null` if there is not enough data in the state to conform a valid request.
+
+**Signature:**
+
+```typescript
+BrowseRequestUpdated: InternalBrowseRequest | null;
+```
+
+## Remarks
+
+The difference from `BrowseRequestChanged` and this event is this one will be executed with more priority (As it is not a `...Changed` event). So we can use this event to modify request params before emitting the `BrowseRequestChanged` and fetch the API.
+

package/docs/API-reference/api/x-components.browsexevents.browseresponsechanged.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; [BrowseXEvents](./x-components.browsexevents.md) &gt; [BrowseResponseChanged](./x-components.browsexevents.browseresponsechanged.md)
+
+## BrowseXEvents.BrowseResponseChanged property
+
+A browse response has been provided. Payload: The provided internal response object.
+
+**Signature:**
+
+```typescript
+BrowseResponseChanged: InternalBrowseResponse;
+```

package/docs/API-reference/api/x-components.browsexevents.browsetaggingchanged.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; [BrowseXEvents](./x-components.browsexevents.md) &gt; [BrowseTaggingChanged](./x-components.browsexevents.browsetaggingchanged.md)
+
+## BrowseXEvents.BrowseTaggingChanged property
+
+Browse tagging has been changed. Payload: The new browse tagging object.
+
+**Signature:**
+
+```typescript
+BrowseTaggingChanged: TaggingRequest;
+```

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

@@ -0,0 +1,172 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseXEvents](./x-components.browsexevents.md)
+
+## BrowseXEvents interface
+
+Dictionary of the events of Browse XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload.
+
+**Signature:**
+
+```typescript
+export interface BrowseXEvents 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[BrowseRequestChanged](./x-components.browsexevents.browserequestchanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null
+
+
+</td><td>
+
+Any property of the browse request has changed. Payload: The new browse request or `null` if there is not enough data in the state to conform a valid request.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseRequestUpdated](./x-components.browsexevents.browserequestupdated.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null
+
+
+</td><td>
+
+Any property of the browse request has been updated. Payload: The new browse request or `null` if there is not enough data in the state to conform a valid request.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseResponseChanged](./x-components.browsexevents.browseresponsechanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[InternalBrowseResponse](./x-components.internalbrowseresponse.md)
+
+
+</td><td>
+
+A browse response has been provided. Payload: The provided internal response object.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseTaggingChanged](./x-components.browsexevents.browsetaggingchanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+TaggingRequest
+
+
+</td><td>
+
+Browse tagging has been changed. Payload: The new browse tagging object.
+
+
+</td></tr>
+<tr><td>
+
+[SelectedBrowseSortProvided](./x-components.browsexevents.selectedbrowsesortprovided.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sort
+
+
+</td><td>
+
+A new selected sort has been provided. Payload: The sort option that has been provided.
+
+
+</td></tr>
+<tr><td>
+
+[UserBrowsedToCategory](./x-components.browsexevents.userbrowsedtocategory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+BrowsableRequest
+
+
+</td><td>
+
+The user has selected a browse category. Payload: The browse category fields needed for the request.
+
+
+</td></tr>
+<tr><td>
+
+[UserClickedABrowseSort](./x-components.browsexevents.userclickedabrowsesort.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sort
+
+
+</td><td>
+
+The user has clicked one of the sorts. Payload: The sort option that the user has selected.
+
+
+</td></tr>
+</tbody></table>
+

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseXEvents](./x-components.browsexevents.md) &gt; [SelectedBrowseSortProvided](./x-components.browsexevents.selectedbrowsesortprovided.md)
+
+## BrowseXEvents.SelectedBrowseSortProvided property
+
+A new selected sort has been provided. Payload: The sort option that has been provided.
+
+**Signature:**
+
+```typescript
+SelectedBrowseSortProvided: Sort;
+```
+
+## Remarks
+
+This event is used when the user of the library wants to provide their own selected sort value.
+

package/docs/API-reference/api/x-components.browsexevents.userbrowsedtocategory.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; [BrowseXEvents](./x-components.browsexevents.md) &gt; [UserBrowsedToCategory](./x-components.browsexevents.userbrowsedtocategory.md)
+
+## BrowseXEvents.UserBrowsedToCategory property
+
+The user has selected a browse category. Payload: The browse category fields needed for the request.
+
+**Signature:**
+
+```typescript
+UserBrowsedToCategory: BrowsableRequest;
+```

package/docs/API-reference/api/x-components.browsexevents.userclickedabrowsesort.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; [BrowseXEvents](./x-components.browsexevents.md) &gt; [UserClickedABrowseSort](./x-components.browsexevents.userclickedabrowsesort.md)
+
+## BrowseXEvents.UserClickedABrowseSort property
+
+The user has clicked one of the sorts. Payload: The sort option that the user has selected.
+
+**Signature:**
+
+```typescript
+UserClickedABrowseSort: Sort;
+```

package/docs/API-reference/api/x-components.browsexmodule.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; [browseXModule](./x-components.browsexmodule.md)
+
+## browseXModule variable
+
+Search [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `browse` entry point.
+
+**Signature:**
+
+```typescript
+browseXModule: BrowseXModule
+```

package/docs/API-reference/api/x-components.browsexstoremodule.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; [BrowseXStoreModule](./x-components.browsexstoremodule.md)
+
+## BrowseXStoreModule type
+
+Browse type safe store module.
+
+**Signature:**
+
+```typescript
+export type BrowseXStoreModule = XStoreModule<BrowseState, BrowseGetters, BrowseMutations, BrowseActions>;
+```
+**References:** [XStoreModule](./x-components.xstoremodule.md)<!-- -->, [BrowseState](./x-components.browsestate.md)<!-- -->, [BrowseGetters](./x-components.browsegetters.md)<!-- -->, [BrowseMutations](./x-components.browsemutations.md)<!-- -->, [BrowseActions](./x-components.browseactions.md)
+

package/docs/API-reference/api/x-components.cancelfetchandsavebrowseresponse.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; [cancelFetchAndSaveBrowseResponse](./x-components.cancelfetchandsavebrowseresponse.md)
+
+## cancelFetchAndSaveBrowseResponse() function
+
+Default implementation for [BrowseActions.cancelFetchAndSaveBrowseResponse](./x-components.browseactions.cancelfetchandsavebrowseresponse.md) action.
+
+**Signature:**
+
+```typescript
+cancelFetchAndSaveBrowseResponse: () => void
+```
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.cancelfetchandsavebrowseresponsewire.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; [cancelFetchAndSaveBrowseResponseWire](./x-components.cancelfetchandsavebrowseresponsewire.md)
+
+## cancelFetchAndSaveBrowseResponseWire variable
+
+Cancels the [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) request promise.
+
+**Signature:**
+
+```typescript
+cancelFetchAndSaveBrowseResponseWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.clearbrowsequery.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; [clearBrowseQuery](./x-components.clearbrowsequery.md)
+
+## clearBrowseQuery variable
+
+Clears the browse state `selectedCategory`<!-- -->.
+
+**Signature:**
+
+```typescript
+clearBrowseQuery: import("../../wiring").AnyWire
+```

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

@@ -0,0 +1,66 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchAndSaveBrowseResponse](./x-components.fetchandsavebrowseresponse.md)
+
+## fetchAndSaveBrowseResponse() function
+
+Default implementation for [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) action.
+
+**Signature:**
+
+```typescript
+fetchAndSaveBrowseResponse: (context: BrowseActionContext, request: InternalBrowseRequest | null) => void | Promise<void>
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+[BrowseActionContext](./x-components.browseactioncontext.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+request
+
+
+</td><td>
+
+[InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void \| Promise&lt;void&gt;
+

package/docs/API-reference/api/x-components.fetchandsavebrowseresponsewire.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; [fetchAndSaveBrowseResponseWire](./x-components.fetchandsavebrowseresponsewire.md)
+
+## fetchAndSaveBrowseResponseWire variable
+
+Requests and stores the browse response.
+
+**Signature:**
+
+```typescript
+fetchAndSaveBrowseResponseWire: import("../../wiring").Wire<InternalBrowseRequest | null>
+```

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

@@ -0,0 +1,66 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [fetchAndSaveBrowseResultsEnrichment](./x-components.fetchandsavebrowseresultsenrichment.md)
+
+## fetchAndSaveBrowseResultsEnrichment() function
+
+Default implementation for [BrowseActions.fetchAndSaveResultsEnrichment](./x-components.browseactions.fetchandsaveresultsenrichment.md) action.
+
+**Signature:**
+
+```typescript
+fetchAndSaveResultsEnrichment: (context: BrowseActionContext, request: Result[]) => void | Promise<void>
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+[BrowseActionContext](./x-components.browseactioncontext.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+request
+
+
+</td><td>
+
+Result\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void \| Promise&lt;void&gt;
+

package/docs/API-reference/api/x-components.fetchandsavebrowseresultsenrichmentwire.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; [fetchAndSaveBrowseResultsEnrichmentWire](./x-components.fetchandsavebrowseresultsenrichmentwire.md)
+
+## fetchAndSaveBrowseResultsEnrichmentWire variable
+
+Requests and stores the enrichment results for the results.
+
+**Signature:**
+
+```typescript
+fetchAndSaveBrowseResultsEnrichmentWire: import("../../wiring").Wire<import("@empathyco/x-types").Result[]>
+```

package/docs/API-reference/api/x-components.fetchbrowseresponse.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; [fetchBrowseResponse](./x-components.fetchbrowseresponse.md)
+
+## fetchBrowseResponse variable
+
+Default implementation for the [BrowseActions.fetchBrowseResponse](./x-components.browseactions.fetchbrowseresponse.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+fetchBrowseResponse: BrowseXStoreModule['actions']['fetchBrowseResponse']
+```

package/docs/API-reference/api/x-components.increasebrowsepageappendingresults.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; [increaseBrowsePageAppendingResults](./x-components.increasebrowsepageappendingresults.md)
+
+## increaseBrowsePageAppendingResults variable
+
+Default implementation for the [BrowseActions.increasePageAppendingResults](./x-components.browseactions.increasepageappendingresults.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+increasePageAppendingResults: BrowseXStoreModule['actions']['increasePageAppendingResults']
+```

package/docs/API-reference/api/x-components.increasebrowsepageappendingresultswire.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; [increaseBrowsePageAppendingResultsWire](./x-components.increasebrowsepageappendingresultswire.md)
+
+## increaseBrowsePageAppendingResultsWire variable
+
+Increases the current browse state `page` by one.
+
+**Signature:**
+
+```typescript
+increaseBrowsePageAppendingResultsWire: import("../../wiring").AnyWire
+```