@empathyco/x-components 7.3.1 → 7.4.1

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.4.1](https://github.com/empathyco/x/compare/@empathyco/x-components@7.4.0...@empathyco/x-components@7.4.1) (2026-07-08)
+
+**Note:** Version bump only for package @empathyco/x-components
+
+
+
+
+
+## [7.4.0](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.1...@empathyco/x-components@7.4.0) (2026-07-07)
+
+### Features
+
+* create browse module (#2128)
+
+
 ## [7.3.1](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.0...@empathyco/x-components@7.3.1) (2026-07-06)
 
 ### Bug Fixes

package/browse/index.d.ts

@@ -0,0 +1 @@
+export * from '../types/src/x-modules/browse';

package/browse/index.js

@@ -0,0 +1,15 @@
+export { default as BrowseResultsList } from '../js/x-modules/browse/components/browse-results-list.vue.js';
+export { default as BrowseSortPickerList } from '../js/x-modules/browse/components/browse-sort-picker-list.vue.js';
+export { cancelFetchAndSaveBrowseResponse, fetchAndSaveBrowseResponse } from '../js/x-modules/browse/store/actions/fetch-and-save-browse-response.action.js';
+export { fetchAndSaveResultsEnrichment as fetchAndSaveBrowseResultsEnrichment } from '../js/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.js';
+export { fetchBrowseResponse } from '../js/x-modules/browse/store/actions/fetch-browse-response.action.js';
+export { increasePageAppendingResults as increaseBrowsePageAppendingResults } from '../js/x-modules/browse/store/actions/increase-page-apending-results.action.js';
+export { resetRequestOnRefinement as resetBrowseRequestOnRefinement } from '../js/x-modules/browse/store/actions/reset-request-on-refinement.action.js';
+export { saveBrowseResponse } from '../js/x-modules/browse/store/actions/save-browse-response.action.js';
+export { saveOrigin as saveBrowseOrigin } from '../js/x-modules/browse/store/actions/save-origin.action.js';
+export { setUrlParams as setBrowseUrlParams } from '../js/x-modules/browse/store/actions/set-url-params.action.js';
+export { browseEmitters } from '../js/x-modules/browse/store/emitters.js';
+export { request as browseRequest } from '../js/x-modules/browse/store/getters/request.getter.js';
+export { browseXStoreModule, resettableBrowseState } from '../js/x-modules/browse/store/module.js';
+export { browseWiring, cancelFetchAndSaveBrowseResponseWire, clearBrowseQuery, fetchAndSaveBrowseResponseWire, fetchAndSaveBrowseResultsEnrichmentWire, increaseBrowsePageAppendingResultsWire, resetBrowseAppending, resetBrowseRequestOnRefinementWire, resetBrowseStateForReloadWire, resetBrowseStateIfNoRequestWire, resetFromNoBrowseResultsWithFilters, resetIsNoBrowseResults, saveBrowseOriginWire, setBrowseCategory, setBrowseExtraParams, setBrowsePage, setBrowseSelectedFilters, setBrowseSort, setBrowseUrlParamsWire } from '../js/x-modules/browse/wiring.js';
+export { browseXModule } from '../js/x-modules/browse/x-module.js';

package/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

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

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseXAPI](./x-components.basexapi.md) &gt; [browse](./x-components.basexapi.browse.md)
+
+## BaseXAPI.browse() method
+
+Browses the browseField and browseValue parameters as a selected category.
+
+**Signature:**
+
+```typescript
+browse(browseCategory?: BrowsableRequest): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+browseCategory
+
+
+</td><td>
+
+BrowsableRequest
+
+
+</td><td>
+
+_(Optional)_ browseField and browseValue to be browsed.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -88,6 +88,20 @@ Description
 Tracks that a product was added to cart from PDP.
 
 
+</td></tr>
+<tr><td>
+
+[browse(browseCategory)](./x-components.basexapi.browse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Browses the browseField and browseValue parameters as a selected category.
+
+
 </td></tr>
 <tr><td>
 

package/docs/API-reference/api/x-components.browseactioncontext.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; [BrowseActionContext](./x-components.browseactioncontext.md)
+
+## BrowseActionContext type
+
+Alias type for actions context of the [BrowseXStoreModule](./x-components.browsexstoremodule.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export type BrowseActionContext = XActionContext<BrowseState, BrowseGetters, BrowseMutations, BrowseActions>;
+```
+**References:** [XActionContext](./x-components.xactioncontext.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.browseactions.cancelfetchandsavebrowseresponse.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; [BrowseActions](./x-components.browseactions.md) &gt; [cancelFetchAndSaveBrowseResponse](./x-components.browseactions.cancelfetchandsavebrowseresponse.md)
+
+## BrowseActions.cancelFetchAndSaveBrowseResponse property
+
+Cancels / interrupt [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) synchronous promise.
+
+**Signature:**
+
+```typescript
+cancelFetchAndSaveBrowseResponse: () => void;
+```

package/docs/API-reference/api/x-components.browseactions.fetchandsavebrowseresponse.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; [BrowseActions](./x-components.browseactions.md) &gt; [fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md)
+
+## BrowseActions.fetchAndSaveBrowseResponse property
+
+Fetches a new browse response and stores them in the module state.
+
+**Signature:**
+
+```typescript
+fetchAndSaveBrowseResponse: (request: InternalBrowseRequest | null) => void;
+```

package/docs/API-reference/api/x-components.browseactions.fetchandsaveresultsenrichment.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; [BrowseActions](./x-components.browseactions.md) &gt; [fetchAndSaveResultsEnrichment](./x-components.browseactions.fetchandsaveresultsenrichment.md)
+
+## BrowseActions.fetchAndSaveResultsEnrichment property
+
+Requests and stores the enrichment results for the results.
+
+**Signature:**
+
+```typescript
+fetchAndSaveResultsEnrichment: (results: Result[]) => void;
+```

package/docs/API-reference/api/x-components.browseactions.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; [BrowseActions](./x-components.browseactions.md) &gt; [fetchBrowseResponse](./x-components.browseactions.fetchbrowseresponse.md)
+
+## BrowseActions.fetchBrowseResponse property
+
+Fetches the browse response and returns them.
+
+**Signature:**
+
+```typescript
+fetchBrowseResponse: (request: BrowseRequest) => BrowseResponse;
+```

package/docs/API-reference/api/x-components.browseactions.increasepageappendingresults.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; [BrowseActions](./x-components.browseactions.md) &gt; [increasePageAppendingResults](./x-components.browseactions.increasepageappendingresults.md)
+
+## BrowseActions.increasePageAppendingResults property
+
+Checks if there are more pages of results to load. If there are, then increases the page number in state and set to `true` the [BrowseState.isAppendResults](./x-components.browsestate.isappendresults.md) flag.
+
+**Signature:**
+
+```typescript
+increasePageAppendingResults: () => void;
+```
+
+## Remarks
+
+This action is to implement the infinite scroll behaviour. To increase the page for other purposes, please use the [BrowseMutations.setPage](./x-components.browsemutations.setpage.md) mutation.
+

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

@@ -0,0 +1,210 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md)
+
+## BrowseActions interface
+
+Browse store actions.
+
+**Signature:**
+
+```typescript
+export interface BrowseActions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cancelFetchAndSaveBrowseResponse](./x-components.browseactions.cancelfetchandsavebrowseresponse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+Cancels / interrupt [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) synchronous promise.
+
+
+</td></tr>
+<tr><td>
+
+[fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(request: [InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null) =&gt; void
+
+
+</td><td>
+
+Fetches a new browse response and stores them in the module state.
+
+
+</td></tr>
+<tr><td>
+
+[fetchAndSaveResultsEnrichment](./x-components.browseactions.fetchandsaveresultsenrichment.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(results: Result\[\]) =&gt; void
+
+
+</td><td>
+
+Requests and stores the enrichment results for the results.
+
+
+</td></tr>
+<tr><td>
+
+[fetchBrowseResponse](./x-components.browseactions.fetchbrowseresponse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(request: BrowseRequest) =&gt; BrowseResponse
+
+
+</td><td>
+
+Fetches the browse response and returns them.
+
+
+</td></tr>
+<tr><td>
+
+[increasePageAppendingResults](./x-components.browseactions.increasepageappendingresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+Checks if there are more pages of results to load. If there are, then increases the page number in state and set to `true` the [BrowseState.isAppendResults](./x-components.browsestate.isappendresults.md) flag.
+
+
+</td></tr>
+<tr><td>
+
+[resetRequestOnRefinement](./x-components.browseactions.resetrequestonrefinement.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(watchedRequest: [WatchedInternalBrowseRequest](./x-components.watchedinternalbrowserequest.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+Batches state resets in a single action after [BrowseGetters.request](./x-components.browsegetters.request.md) parameters update.
+
+
+</td></tr>
+<tr><td>
+
+[saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(response: BrowseResponse) =&gt; void
+
+
+</td><td>
+
+Saves the [BrowseResponse](./x-types.browseresponse.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[saveOrigin](./x-components.browseactions.saveorigin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(originInit: [QueryOriginInit](./x-components.queryorigininit.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it.
+
+
+</td></tr>
+<tr><td>
+
+[setUrlParams](./x-components.browseactions.seturlparams.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+Checks if the url has params on it and then updates the state with these values.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.browseactions.resetrequestonrefinement.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; [BrowseActions](./x-components.browseactions.md) &gt; [resetRequestOnRefinement](./x-components.browseactions.resetrequestonrefinement.md)
+
+## BrowseActions.resetRequestOnRefinement property
+
+Batches state resets in a single action after [BrowseGetters.request](./x-components.browsegetters.request.md) parameters update.
+
+**Signature:**
+
+```typescript
+resetRequestOnRefinement: (watchedRequest: WatchedInternalBrowseRequest) => void;
+```

package/docs/API-reference/api/x-components.browseactions.savebrowseresponse.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; [BrowseActions](./x-components.browseactions.md) &gt; [saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)
+
+## BrowseActions.saveBrowseResponse property
+
+Saves the [BrowseResponse](./x-types.browseresponse.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+saveBrowseResponse: (response: BrowseResponse) => void;
+```

package/docs/API-reference/api/x-components.browseactions.saveorigin.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; [BrowseActions](./x-components.browseactions.md) &gt; [saveOrigin](./x-components.browseactions.saveorigin.md)
+
+## BrowseActions.saveOrigin property
+
+Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it.
+
+**Signature:**
+
+```typescript
+saveOrigin: (originInit: QueryOriginInit) => void;
+```

package/docs/API-reference/api/x-components.browseactions.seturlparams.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; [BrowseActions](./x-components.browseactions.md) &gt; [setUrlParams](./x-components.browseactions.seturlparams.md)
+
+## BrowseActions.setUrlParams property
+
+Checks if the url has params on it and then updates the state with these values.
+
+**Signature:**
+
+```typescript
+setUrlParams: (urlParams: UrlParams) => void;
+```

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

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseConfig](./x-components.browseconfig.md)
+
+## BrowseConfig interface
+
+Configuration options for the [BrowseXModule](./x-components.browsexmodule.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface BrowseConfig 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[pageMode](./x-components.browseconfig.pagemode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PageMode](./x-components.pagemode.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[pageSize](./x-components.browseconfig.pagesize.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Maximum number of results to request.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.browseconfig.pagemode.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; [BrowseConfig](./x-components.browseconfig.md) &gt; [pageMode](./x-components.browseconfig.pagemode.md)
+
+## BrowseConfig.pageMode property
+
+**Signature:**
+
+```typescript
+pageMode: PageMode;
+```

package/docs/API-reference/api/x-components.browseconfig.pagesize.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; [BrowseConfig](./x-components.browseconfig.md) &gt; [pageSize](./x-components.browseconfig.pagesize.md)
+
+## BrowseConfig.pageSize property
+
+Maximum number of results to request.
+
+**Signature:**
+
+```typescript
+pageSize: number;
+```

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

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseGetters](./x-components.browsegetters.md)
+
+## BrowseGetters interface
+
+Browse store getters.
+
+**Signature:**
+
+```typescript
+export interface BrowseGetters 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[request](./x-components.browsegetters.request.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null
+
+
+</td><td>
+
+The adapter request object for retrieving the results, or null if there is no valid data to create a request.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.browsegetters.request.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; [BrowseGetters](./x-components.browsegetters.md) &gt; [request](./x-components.browsegetters.request.md)
+
+## BrowseGetters.request property
+
+The adapter request object for retrieving the results, or null if there is no valid data to create a request.
+
+**Signature:**
+
+```typescript
+request: InternalBrowseRequest | null;
+```

package/docs/API-reference/api/x-components.browsemutations.appendresults.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; [BrowseMutations](./x-components.browsemutations.md) &gt; [appendResults](./x-components.browsemutations.appendresults.md)
+
+## BrowseMutations.appendResults property
+
+Append the results to the results state.
+
+**Signature:**
+
+```typescript
+appendResults: (results: Result[]) => void;
+```