@empathyco/x-components 7.4.0 → 7.4.1

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

@@ -248,6 +248,17 @@ Reduce an array of objects to an object which properties names are the value of
 Asserts that the passed options object is valid, providing helpful error messages.
 
 
+</td></tr>
+<tr><td>
+
+[cancelFetchAndSaveBrowseResponse()](./x-components.cancelfetchandsavebrowseresponse.md)
+
+
+</td><td>
+
+Default implementation for [BrowseActions.cancelFetchAndSaveBrowseResponse](./x-components.browseactions.cancelfetchandsavebrowseresponse.md) action.
+
+
 </td></tr>
 <tr><td>
 
@@ -578,6 +589,28 @@ Filters an array with all elements that pass the test implemented by the given f
 Flat an `Item[]` deeply using the given `childrenKey` to access to his children.
 
 
+</td></tr>
+<tr><td>
+
+[fetchAndSaveBrowseResponse(context, request)](./x-components.fetchandsavebrowseresponse.md)
+
+
+</td><td>
+
+Default implementation for [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) action.
+
+
+</td></tr>
+<tr><td>
+
+[fetchAndSaveBrowseResultsEnrichment(context, request)](./x-components.fetchandsavebrowseresultsenrichment.md)
+
+
+</td><td>
+
+Default implementation for [BrowseActions.fetchAndSaveResultsEnrichment](./x-components.browseactions.fetchandsaveresultsenrichment.md) action.
+
+
 </td></tr>
 <tr><td>
 
@@ -1470,6 +1503,72 @@ Ai module state.
 Dictionary of the events of AI XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload.
 
 
+</td></tr>
+<tr><td>
+
+[BrowseActions](./x-components.browseactions.md)
+
+
+</td><td>
+
+Browse store actions.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseConfig](./x-components.browseconfig.md)
+
+
+</td><td>
+
+Configuration options for the [BrowseXModule](./x-components.browsexmodule.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseGetters](./x-components.browsegetters.md)
+
+
+</td><td>
+
+Browse store getters.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseMutations](./x-components.browsemutations.md)
+
+
+</td><td>
+
+Browse store mutations.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseState](./x-components.browsestate.md)
+
+
+</td><td>
+
+Browse store state.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseXEvents](./x-components.browsexevents.md)
+
+
+</td><td>
+
+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.
+
+
 </td></tr>
 <tr><td>
 
@@ -2077,6 +2176,28 @@ Interface for the returned type of the [XInstaller.init()](./x-components.xinsta
 Interface for the parameter of the constructor of [XInstaller](./x-components.xinstaller.md) function. It is an extended version of [XPluginOptions](./x-components.xpluginoptions.md)<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[InternalBrowseRequest](./x-components.internalbrowserequest.md)
+
+
+</td><td>
+
+An internal browse request containing the page used to calculate the start and rows properties of a [BrowseRequest](./x-types.browserequest.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[InternalBrowseResponse](./x-components.internalbrowseresponse.md)
+
+
+</td><td>
+
+An internal browse response containing the [InternalBrowseRequest](./x-components.internalbrowserequest.md) performed to get a [BrowseResponse](./x-types.browseresponse.md) and its [RequestStatus](./x-components.requeststatus.md)<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -3254,6 +3375,17 @@ Alias to facilitate retrieving the modules with query.
 Alias to facilitate retrieving the modules with status.
 
 
+</td></tr>
+<tr><td>
+
+[WatchedInternalBrowseRequest](./x-components.watchedinternalbrowserequest.md)
+
+
+</td><td>
+
+A representation of a watched [InternalBrowseRequest](./x-components.internalbrowserequest.md) object, wrapping its new and old values.
+
+
 </td></tr>
 <tr><td>
 
@@ -4113,6 +4245,54 @@ Simple panel that receives its open state via prop, which is responsible of rend
 The `BaseVariableColumnGrid` component is a wrapper of the `BaseGrid` component that listens to the `UserClickedColumnPicker` and the `ColumnsNumberProvided` events and passes the selected number of columns to the grid. It also allows to customize the grid items using the available `scopedSlots`<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[browseRequest](./x-components.browserequest.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseGetters.request](./x-components.browsegetters.request.md) getter.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseResultsList](./x-components.browseresultslist.md)
+
+
+</td><td>
+
+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 `results` bound.
+
+It also provides the slot result to customize the item, which is within the default slot, with the result bound.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseSortPickerList](./x-components.browsesortpickerlist.md)
+
+
+</td><td>
+
+The `SortPickerList` component allows user to select the browse results order. This component also allows to change the selected sort programmatically.
+
+
+</td></tr>
+<tr><td>
+
+[browseXModule](./x-components.browsexmodule.md)
+
+
+</td><td>
+
+Search [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `browse` entry point.
+
+
 </td></tr>
 <tr><td>
 
@@ -4124,6 +4304,17 @@ The `BaseVariableColumnGrid` component is a wrapper of the `BaseGrid` component
 Default XBus implementation.
 
 
+</td></tr>
+<tr><td>
+
+[cancelFetchAndSaveBrowseResponseWire](./x-components.cancelfetchandsavebrowseresponsewire.md)
+
+
+</td><td>
+
+Cancels the [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) request promise.
+
+
 </td></tr>
 <tr><td>
 
@@ -4177,6 +4368,17 @@ Cancels the [QuerySuggestionsActions.fetchAndSaveSuggestions](./x-components.que
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[clearBrowseQuery](./x-components.clearbrowsequery.md)
+
+
+</td><td>
+
+Clears the browse state `selectedCategory`<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -4623,6 +4825,28 @@ Default implementation for the [AiActions.fetchAndSaveAiSuggestions](./x-compone
 Default implementation for the `AiActions.fetchAndSaveAiSuggestionsSearch`<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[fetchAndSaveBrowseResponseWire](./x-components.fetchandsavebrowseresponsewire.md)
+
+
+</td><td>
+
+Requests and stores the browse response.
+
+
+</td></tr>
+<tr><td>
+
+[fetchAndSaveBrowseResultsEnrichmentWire](./x-components.fetchandsavebrowseresultsenrichmentwire.md)
+
+
+</td><td>
+
+Requests and stores the enrichment results for the results.
+
+
 </td></tr>
 <tr><td>
 
@@ -4777,6 +5001,17 @@ Requests and stores the semantic query results.
 Requests and stores a new set of query suggestions for the query.
 
 
+</td></tr>
+<tr><td>
+
+[fetchBrowseResponse](./x-components.fetchbrowseresponse.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseActions.fetchBrowseResponse](./x-components.browseactions.fetchbrowseresponse.md)<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -5074,6 +5309,28 @@ Default implementation for the [IdentifierResultsGetters.identifierResultsReques
 IdentifierResults [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `identifier-results` entry point.
 
 
+</td></tr>
+<tr><td>
+
+[increaseBrowsePageAppendingResults](./x-components.increasebrowsepageappendingresults.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseActions.increasePageAppendingResults](./x-components.browseactions.increasepageappendingresults.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[increaseBrowsePageAppendingResultsWire](./x-components.increasebrowsepageappendingresultswire.md)
+
+
+</td><td>
+
+Increases the current browse state `page` by one.
+
+
 </td></tr>
 <tr><td>
 
@@ -5846,6 +6103,72 @@ Renders default slot content. It binds to the default slot a [BooleanFilter](./x
 Resets the search state `isAppendingResults`<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[resetBrowseAppending](./x-components.resetbrowseappending.md)
+
+
+</td><td>
+
+Resets the browse state `isAppendingResults`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[resetBrowseRequestOnRefinement](./x-components.resetbrowserequestonrefinement.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseActions.resetRequestOnRefinement](./x-components.browseactions.resetrequestonrefinement.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[resetBrowseRequestOnRefinementWire](./x-components.resetbrowserequestonrefinementwire.md)
+
+
+</td><td>
+
+Resets the [BrowseGetters.request](./x-components.browsegetters.request.md) parameters when refining request and before the actual request is launched.
+
+
+</td></tr>
+<tr><td>
+
+[resetBrowseStateForReloadWire](./x-components.resetbrowsestateforreloadwire.md)
+
+
+</td><td>
+
+Resets the browse state to reload the current browse.
+
+
+</td></tr>
+<tr><td>
+
+[resetBrowseStateIfNoRequestWire](./x-components.resetbrowsestateifnorequestwire.md)
+
+
+</td><td>
+
+Resets the browse state when the request is changed to null. See the [BrowseXStoreModule](./x-components.browsexstoremodule.md) for details.
+
+
+</td></tr>
+<tr><td>
+
+[resetFromNoBrowseResultsWithFilters](./x-components.resetfromnobrowseresultswithfilters.md)
+
+
+</td><td>
+
+Resets the browse state `fromNoResultsWithFilters`<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -5857,6 +6180,17 @@ Resets the search state `isAppendingResults`<!-- -->.
 Resets the search state `fromNoResultsWithFilters`<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[resetIsNoBrowseResults](./x-components.resetisnobrowseresults.md)
+
+
+</td><td>
+
+Resets the browse state `isNoResults`<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -6019,6 +6353,39 @@ It provides the original result, the array containing the selected variants and
 Default implementation for the [AiActions.saveOrigin](./x-components.aiactions.saveorigin.md)<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[saveBrowseOrigin](./x-components.savebrowseorigin.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseActions.saveOrigin](./x-components.browseactions.saveorigin.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[saveBrowseOriginWire](./x-components.savebrowseoriginwire.md)
+
+
+</td><td>
+
+Sets the browse state `origin`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[saveBrowseResponse](./x-components.savebrowseresponse.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseActions.saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -6300,6 +6667,83 @@ Default implementation for the [HistoryQueriesGetters.sessionHistoryQueries](./x
 Default implementation setUrlParams.
 
 
+</td></tr>
+<tr><td>
+
+[setBrowseCategory](./x-components.setbrowsecategory.md)
+
+
+</td><td>
+
+Sets the browse state `selectedCategory`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowseExtraParams](./x-components.setbrowseextraparams.md)
+
+
+</td><td>
+
+Sets the browse state `params`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowsePage](./x-components.setbrowsepage.md)
+
+
+</td><td>
+
+Sets the browse state `page`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowseSelectedFilters](./x-components.setbrowseselectedfilters.md)
+
+
+</td><td>
+
+Sets the browse state `selectedFilters`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowseSort](./x-components.setbrowsesort.md)
+
+
+</td><td>
+
+Sets the browse state `sort`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowseUrlParams](./x-components.setbrowseurlparams.md)
+
+
+</td><td>
+
+Default implementation for the [BrowseActions.setUrlParams](./x-components.browseactions.seturlparams.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowseUrlParamsWire](./x-components.setbrowseurlparamswire.md)
+
+
+</td><td>
+
+Sets the browse state `query`<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -7813,6 +8257,39 @@ Alias for any store module option. Use only when you don't care about the module
 Union type containing the existing arrow keys.
 
 
+</td></tr>
+<tr><td>
+
+[BrowseActionContext](./x-components.browseactioncontext.md)
+
+
+</td><td>
+
+Alias type for actions context of the [BrowseXStoreModule](./x-components.browsexstoremodule.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseXModule](./x-components.browsexmodule.md)
+
+
+</td><td>
+
+Search [XModule](./x-components.xmodule.md) alias.
+
+
+</td></tr>
+<tr><td>
+
+[BrowseXStoreModule](./x-components.browsexstoremodule.md)
+
+
+</td><td>
+
+Browse type safe store module.
+
+
 </td></tr>
 <tr><td>
 

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

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

package/docs/API-reference/api/x-components.resetbrowserequestonrefinementwire.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; [resetBrowseRequestOnRefinementWire](./x-components.resetbrowserequestonrefinementwire.md)
+
+## resetBrowseRequestOnRefinementWire variable
+
+Resets the [BrowseGetters.request](./x-components.browsegetters.request.md) parameters when refining request and before the actual request is launched.
+
+**Signature:**
+
+```typescript
+resetBrowseRequestOnRefinementWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.resetbrowsestateforreloadwire.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; [resetBrowseStateForReloadWire](./x-components.resetbrowsestateforreloadwire.md)
+
+## resetBrowseStateForReloadWire variable
+
+Resets the browse state to reload the current browse.
+
+**Signature:**
+
+```typescript
+resetBrowseStateForReloadWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.resetbrowsestateifnorequestwire.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; [resetBrowseStateIfNoRequestWire](./x-components.resetbrowsestateifnorequestwire.md)
+
+## resetBrowseStateIfNoRequestWire variable
+
+Resets the browse state when the request is changed to null. See the [BrowseXStoreModule](./x-components.browsexstoremodule.md) for details.
+
+**Signature:**
+
+```typescript
+resetBrowseStateIfNoRequestWire: import("../../wiring").Wire<InternalBrowseRequest | null>
+```

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

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

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