@empathyco/x-components 7.4.0 → 7.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/browse/index.d.ts +1 -0
  3. package/browse/index.js +15 -0
  4. package/core/index.js.map +1 -1
  5. package/docs/API-reference/api/x-components.browseactioncontext.md +15 -0
  6. package/docs/API-reference/api/x-components.browseactions.cancelfetchandsavebrowseresponse.md +13 -0
  7. package/docs/API-reference/api/x-components.browseactions.fetchandsavebrowseresponse.md +13 -0
  8. package/docs/API-reference/api/x-components.browseactions.fetchandsaveresultsenrichment.md +13 -0
  9. package/docs/API-reference/api/x-components.browseactions.fetchbrowseresponse.md +13 -0
  10. package/docs/API-reference/api/x-components.browseactions.increasepageappendingresults.md +18 -0
  11. package/docs/API-reference/api/x-components.browseactions.md +210 -0
  12. package/docs/API-reference/api/x-components.browseactions.resetrequestonrefinement.md +13 -0
  13. package/docs/API-reference/api/x-components.browseactions.savebrowseresponse.md +13 -0
  14. package/docs/API-reference/api/x-components.browseactions.saveorigin.md +13 -0
  15. package/docs/API-reference/api/x-components.browseactions.seturlparams.md +13 -0
  16. package/docs/API-reference/api/x-components.browseconfig.md +75 -0
  17. package/docs/API-reference/api/x-components.browseconfig.pagemode.md +11 -0
  18. package/docs/API-reference/api/x-components.browseconfig.pagesize.md +13 -0
  19. package/docs/API-reference/api/x-components.browsegetters.md +58 -0
  20. package/docs/API-reference/api/x-components.browsegetters.request.md +13 -0
  21. package/docs/API-reference/api/x-components.browsemutations.appendresults.md +13 -0
  22. package/docs/API-reference/api/x-components.browsemutations.md +458 -0
  23. package/docs/API-reference/api/x-components.browsemutations.resetstate.md +13 -0
  24. package/docs/API-reference/api/x-components.browsemutations.resetstateforreload.md +13 -0
  25. package/docs/API-reference/api/x-components.browsemutations.setbanners.md +13 -0
  26. package/docs/API-reference/api/x-components.browsemutations.setbrowsetagging.md +13 -0
  27. package/docs/API-reference/api/x-components.browsemutations.setdisplaybrowsetagging.md +13 -0
  28. package/docs/API-reference/api/x-components.browsemutations.setfacets.md +13 -0
  29. package/docs/API-reference/api/x-components.browsemutations.setfromnoresultswithfilters.md +13 -0
  30. package/docs/API-reference/api/x-components.browsemutations.setisappendresults.md +13 -0
  31. package/docs/API-reference/api/x-components.browsemutations.setisnoresults.md +13 -0
  32. package/docs/API-reference/api/x-components.browsemutations.setorigin.md +13 -0
  33. package/docs/API-reference/api/x-components.browsemutations.setpage.md +13 -0
  34. package/docs/API-reference/api/x-components.browsemutations.setparams.md +13 -0
  35. package/docs/API-reference/api/x-components.browsemutations.setpromoteds.md +13 -0
  36. package/docs/API-reference/api/x-components.browsemutations.setresults.md +13 -0
  37. package/docs/API-reference/api/x-components.browsemutations.setselectedcategory.md +13 -0
  38. package/docs/API-reference/api/x-components.browsemutations.setselectedfilters.md +13 -0
  39. package/docs/API-reference/api/x-components.browsemutations.setsort.md +13 -0
  40. package/docs/API-reference/api/x-components.browsemutations.setstats.md +13 -0
  41. package/docs/API-reference/api/x-components.browsemutations.settotalresults.md +13 -0
  42. package/docs/API-reference/api/x-components.browsemutations.updateresult.md +13 -0
  43. package/docs/API-reference/api/x-components.browsemutations.updateresultsfromenrichment.md +13 -0
  44. package/docs/API-reference/api/x-components.browserequest.md +13 -0
  45. package/docs/API-reference/api/x-components.browseresultslist.md +31 -0
  46. package/docs/API-reference/api/x-components.browsesortpickerlist.md +45 -0
  47. package/docs/API-reference/api/x-components.browsestate.banners.md +13 -0
  48. package/docs/API-reference/api/x-components.browsestate.browsetagging.md +13 -0
  49. package/docs/API-reference/api/x-components.browsestate.config.md +13 -0
  50. package/docs/API-reference/api/x-components.browsestate.displaybrowsetagging.md +13 -0
  51. package/docs/API-reference/api/x-components.browsestate.facets.md +13 -0
  52. package/docs/API-reference/api/x-components.browsestate.fromnoresultswithfilters.md +13 -0
  53. package/docs/API-reference/api/x-components.browsestate.isappendresults.md +13 -0
  54. package/docs/API-reference/api/x-components.browsestate.isnoresults.md +13 -0
  55. package/docs/API-reference/api/x-components.browsestate.md +382 -0
  56. package/docs/API-reference/api/x-components.browsestate.origin.md +13 -0
  57. package/docs/API-reference/api/x-components.browsestate.page.md +13 -0
  58. package/docs/API-reference/api/x-components.browsestate.params.md +13 -0
  59. package/docs/API-reference/api/x-components.browsestate.promoteds.md +13 -0
  60. package/docs/API-reference/api/x-components.browsestate.results.md +13 -0
  61. package/docs/API-reference/api/x-components.browsestate.selectedcategory.md +13 -0
  62. package/docs/API-reference/api/x-components.browsestate.selectedfilters.md +13 -0
  63. package/docs/API-reference/api/x-components.browsestate.sort.md +13 -0
  64. package/docs/API-reference/api/x-components.browsestate.stats.md +13 -0
  65. package/docs/API-reference/api/x-components.browsestate.totalresults.md +13 -0
  66. package/docs/API-reference/api/x-components.browsexevents.browserequestchanged.md +13 -0
  67. package/docs/API-reference/api/x-components.browsexevents.browserequestupdated.md +18 -0
  68. package/docs/API-reference/api/x-components.browsexevents.browseresponsechanged.md +13 -0
  69. package/docs/API-reference/api/x-components.browsexevents.browsetaggingchanged.md +13 -0
  70. package/docs/API-reference/api/x-components.browsexevents.md +172 -0
  71. package/docs/API-reference/api/x-components.browsexevents.selectedbrowsesortprovided.md +18 -0
  72. package/docs/API-reference/api/x-components.browsexevents.userbrowsedtocategory.md +13 -0
  73. package/docs/API-reference/api/x-components.browsexevents.userclickedabrowsesort.md +13 -0
  74. package/docs/API-reference/api/x-components.browsexmodule.md +13 -0
  75. package/docs/API-reference/api/x-components.browsexstoremodule.md +15 -0
  76. package/docs/API-reference/api/x-components.cancelfetchandsavebrowseresponse.md +17 -0
  77. package/docs/API-reference/api/x-components.cancelfetchandsavebrowseresponsewire.md +13 -0
  78. package/docs/API-reference/api/x-components.clearbrowsequery.md +13 -0
  79. package/docs/API-reference/api/x-components.fetchandsavebrowseresponse.md +66 -0
  80. package/docs/API-reference/api/x-components.fetchandsavebrowseresponsewire.md +13 -0
  81. package/docs/API-reference/api/x-components.fetchandsavebrowseresultsenrichment.md +66 -0
  82. package/docs/API-reference/api/x-components.fetchandsavebrowseresultsenrichmentwire.md +13 -0
  83. package/docs/API-reference/api/x-components.fetchbrowseresponse.md +13 -0
  84. package/docs/API-reference/api/x-components.increasebrowsepageappendingresults.md +13 -0
  85. package/docs/API-reference/api/x-components.increasebrowsepageappendingresultswire.md +13 -0
  86. package/docs/API-reference/api/x-components.internalbrowserequest.md +59 -0
  87. package/docs/API-reference/api/x-components.internalbrowserequest.page.md +13 -0
  88. package/docs/API-reference/api/x-components.internalbrowseresponse.md +78 -0
  89. package/docs/API-reference/api/x-components.internalbrowseresponse.request.md +13 -0
  90. package/docs/API-reference/api/x-components.internalbrowseresponse.status.md +13 -0
  91. package/docs/API-reference/api/x-components.md +477 -0
  92. package/docs/API-reference/api/x-components.resetbrowseappending.md +13 -0
  93. package/docs/API-reference/api/x-components.resetbrowserequestonrefinement.md +13 -0
  94. package/docs/API-reference/api/x-components.resetbrowserequestonrefinementwire.md +13 -0
  95. package/docs/API-reference/api/x-components.resetbrowsestateforreloadwire.md +13 -0
  96. package/docs/API-reference/api/x-components.resetbrowsestateifnorequestwire.md +13 -0
  97. package/docs/API-reference/api/x-components.resetfromnobrowseresultswithfilters.md +13 -0
  98. package/docs/API-reference/api/x-components.resetisnobrowseresults.md +13 -0
  99. package/docs/API-reference/api/x-components.savebrowseorigin.md +13 -0
  100. package/docs/API-reference/api/x-components.savebrowseoriginwire.md +13 -0
  101. package/docs/API-reference/api/x-components.savebrowseresponse.md +13 -0
  102. package/docs/API-reference/api/x-components.setbrowsecategory.md +13 -0
  103. package/docs/API-reference/api/x-components.setbrowseextraparams.md +13 -0
  104. package/docs/API-reference/api/x-components.setbrowsepage.md +13 -0
  105. package/docs/API-reference/api/x-components.setbrowseselectedfilters.md +13 -0
  106. package/docs/API-reference/api/x-components.setbrowsesort.md +13 -0
  107. package/docs/API-reference/api/x-components.setbrowseurlparams.md +13 -0
  108. package/docs/API-reference/api/x-components.setbrowseurlparamswire.md +13 -0
  109. package/docs/API-reference/api/x-components.snippetcallbacks.md +3 -3
  110. package/docs/API-reference/api/x-components.usealiasapi.browsetotalresults.md +1 -1
  111. package/docs/API-reference/api/x-components.usealiasapi.md +1 -1
  112. package/docs/API-reference/api/x-components.watchedinternalbrowserequest.md +73 -0
  113. package/docs/API-reference/api/x-components.watchedinternalbrowserequest.newrequest.md +11 -0
  114. package/docs/API-reference/api/x-components.watchedinternalbrowserequest.oldrequest.md +11 -0
  115. package/docs/API-reference/api/x-components.xeventstypes.md +1 -1
  116. package/docs/API-reference/api/x-components.xmodulestree.md +1 -1
  117. package/js/index.js +15 -0
  118. package/js/index.js.map +1 -1
  119. package/js/wiring/namespaced-wires.factory.js +1 -1
  120. package/js/x-modules/browse/components/browse-results-list.vue.js +46 -0
  121. package/js/x-modules/browse/components/browse-results-list.vue.js.map +1 -0
  122. package/js/x-modules/browse/components/browse-results-list.vue2.js +6 -0
  123. package/js/x-modules/browse/components/browse-results-list.vue2.js.map +1 -0
  124. package/js/x-modules/browse/components/browse-sort-picker-list.vue.js +73 -0
  125. package/js/x-modules/browse/components/browse-sort-picker-list.vue.js.map +1 -0
  126. package/js/x-modules/browse/components/browse-sort-picker-list.vue2.js +6 -0
  127. package/js/x-modules/browse/components/browse-sort-picker-list.vue2.js.map +1 -0
  128. package/js/x-modules/browse/store/actions/fetch-and-save-browse-response.action.js +57 -0
  129. package/js/x-modules/browse/store/actions/fetch-and-save-browse-response.action.js.map +1 -0
  130. package/js/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.js +21 -0
  131. package/js/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.js.map +1 -0
  132. package/js/x-modules/browse/store/actions/fetch-browse-response.action.js +16 -0
  133. package/js/x-modules/browse/store/actions/fetch-browse-response.action.js.map +1 -0
  134. package/js/x-modules/browse/store/actions/increase-page-apending-results.action.js +18 -0
  135. package/js/x-modules/browse/store/actions/increase-page-apending-results.action.js.map +1 -0
  136. package/js/x-modules/browse/store/actions/reset-request-on-refinement.action.js +36 -0
  137. package/js/x-modules/browse/store/actions/reset-request-on-refinement.action.js.map +1 -0
  138. package/js/x-modules/browse/store/actions/save-browse-response.action.js +42 -0
  139. package/js/x-modules/browse/store/actions/save-browse-response.action.js.map +1 -0
  140. package/js/x-modules/browse/store/actions/save-origin.action.js +16 -0
  141. package/js/x-modules/browse/store/actions/save-origin.action.js.map +1 -0
  142. package/js/x-modules/browse/store/actions/set-url-params.action.js +20 -0
  143. package/js/x-modules/browse/store/actions/set-url-params.action.js.map +1 -0
  144. package/js/x-modules/browse/store/emitters.js +48 -0
  145. package/js/x-modules/browse/store/emitters.js.map +1 -0
  146. package/js/x-modules/browse/store/getters/request.getter.js +27 -0
  147. package/js/x-modules/browse/store/getters/request.getter.js.map +1 -0
  148. package/js/x-modules/browse/store/module.js +163 -0
  149. package/js/x-modules/browse/store/module.js.map +1 -0
  150. package/js/x-modules/browse/wiring.js +213 -0
  151. package/js/x-modules/browse/wiring.js.map +1 -0
  152. package/js/x-modules/browse/x-module.js +21 -0
  153. package/js/x-modules/browse/x-module.js.map +1 -0
  154. package/package.json +2 -2
  155. package/report/x-components.api.json +3922 -119
  156. package/report/x-components.api.md +373 -9
  157. package/types/src/components/snippet-callbacks.vue.d.ts +3 -3
  158. package/types/src/index.d.ts +1 -0
  159. package/types/src/index.d.ts.map +1 -1
  160. package/types/src/x-modules/browse/components/browse-results-list.vue.d.ts +30 -0
  161. package/types/src/x-modules/browse/components/browse-results-list.vue.d.ts.map +1 -0
  162. package/types/src/x-modules/browse/components/browse-sort-picker-list.vue.d.ts +50 -0
  163. package/types/src/x-modules/browse/components/browse-sort-picker-list.vue.d.ts.map +1 -0
  164. package/types/src/x-modules/browse/store/actions/index.d.ts +5 -5
  165. package/types/src/x-modules/browse/store/actions/index.d.ts.map +1 -1
  166. package/types/src/x-modules/browse/store/module.d.ts +1 -1
  167. package/types/src/x-modules/browse/store/module.d.ts.map +1 -1
  168. package/types/src/x-modules/browse/wiring.d.ts +26 -26
  169. package/types/src/x-modules/browse/wiring.d.ts.map +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [7.4.1](https://github.com/empathyco/x/compare/@empathyco/x-components@7.4.0...@empathyco/x-components@7.4.1) (2026-07-08)
7
+
8
+ **Note:** Version bump only for package @empathyco/x-components
9
+
10
+
11
+
12
+
13
+
6
14
  ## [7.4.0](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.1...@empathyco/x-components@7.4.0) (2026-07-07)
7
15
 
8
16
  ### Features
@@ -0,0 +1 @@
1
+ export * from '../types/src/x-modules/browse';
@@ -0,0 +1,15 @@
1
+ export { default as BrowseResultsList } from '../js/x-modules/browse/components/browse-results-list.vue.js';
2
+ export { default as BrowseSortPickerList } from '../js/x-modules/browse/components/browse-sort-picker-list.vue.js';
3
+ export { cancelFetchAndSaveBrowseResponse, fetchAndSaveBrowseResponse } from '../js/x-modules/browse/store/actions/fetch-and-save-browse-response.action.js';
4
+ export { fetchAndSaveResultsEnrichment as fetchAndSaveBrowseResultsEnrichment } from '../js/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.js';
5
+ export { fetchBrowseResponse } from '../js/x-modules/browse/store/actions/fetch-browse-response.action.js';
6
+ export { increasePageAppendingResults as increaseBrowsePageAppendingResults } from '../js/x-modules/browse/store/actions/increase-page-apending-results.action.js';
7
+ export { resetRequestOnRefinement as resetBrowseRequestOnRefinement } from '../js/x-modules/browse/store/actions/reset-request-on-refinement.action.js';
8
+ export { saveBrowseResponse } from '../js/x-modules/browse/store/actions/save-browse-response.action.js';
9
+ export { saveOrigin as saveBrowseOrigin } from '../js/x-modules/browse/store/actions/save-origin.action.js';
10
+ export { setUrlParams as setBrowseUrlParams } from '../js/x-modules/browse/store/actions/set-url-params.action.js';
11
+ export { browseEmitters } from '../js/x-modules/browse/store/emitters.js';
12
+ export { request as browseRequest } from '../js/x-modules/browse/store/getters/request.getter.js';
13
+ export { browseXStoreModule, resettableBrowseState } from '../js/x-modules/browse/store/module.js';
14
+ 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';
15
+ export { browseXModule } from '../js/x-modules/browse/x-module.js';
package/core/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActionContext](./x-components.browseactioncontext.md)
4
+
5
+ ## BrowseActionContext type
6
+
7
+ Alias type for actions context of the [BrowseXStoreModule](./x-components.browsexstoremodule.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type BrowseActionContext = XActionContext<BrowseState, BrowseGetters, BrowseMutations, BrowseActions>;
13
+ ```
14
+ **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)
15
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [cancelFetchAndSaveBrowseResponse](./x-components.browseactions.cancelfetchandsavebrowseresponse.md)
4
+
5
+ ## BrowseActions.cancelFetchAndSaveBrowseResponse property
6
+
7
+ Cancels / interrupt [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) synchronous promise.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ cancelFetchAndSaveBrowseResponse: () => void;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md)
4
+
5
+ ## BrowseActions.fetchAndSaveBrowseResponse property
6
+
7
+ Fetches a new browse response and stores them in the module state.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchAndSaveBrowseResponse: (request: InternalBrowseRequest | null) => void;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [fetchAndSaveResultsEnrichment](./x-components.browseactions.fetchandsaveresultsenrichment.md)
4
+
5
+ ## BrowseActions.fetchAndSaveResultsEnrichment property
6
+
7
+ Requests and stores the enrichment results for the results.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchAndSaveResultsEnrichment: (results: Result[]) => void;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [fetchBrowseResponse](./x-components.browseactions.fetchbrowseresponse.md)
4
+
5
+ ## BrowseActions.fetchBrowseResponse property
6
+
7
+ Fetches the browse response and returns them.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ fetchBrowseResponse: (request: BrowseRequest) => BrowseResponse;
13
+ ```
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [increasePageAppendingResults](./x-components.browseactions.increasepageappendingresults.md)
4
+
5
+ ## BrowseActions.increasePageAppendingResults property
6
+
7
+ 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.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ increasePageAppendingResults: () => void;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ 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.
18
+
@@ -0,0 +1,210 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md)
4
+
5
+ ## BrowseActions interface
6
+
7
+ Browse store actions.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface BrowseActions
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ [cancelFetchAndSaveBrowseResponse](./x-components.browseactions.cancelfetchandsavebrowseresponse.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ () =&gt; void
49
+
50
+
51
+ </td><td>
52
+
53
+ Cancels / interrupt [BrowseActions.fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md) synchronous promise.
54
+
55
+
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ [fetchAndSaveBrowseResponse](./x-components.browseactions.fetchandsavebrowseresponse.md)
60
+
61
+
62
+ </td><td>
63
+
64
+
65
+ </td><td>
66
+
67
+ (request: [InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null) =&gt; void
68
+
69
+
70
+ </td><td>
71
+
72
+ Fetches a new browse response and stores them in the module state.
73
+
74
+
75
+ </td></tr>
76
+ <tr><td>
77
+
78
+ [fetchAndSaveResultsEnrichment](./x-components.browseactions.fetchandsaveresultsenrichment.md)
79
+
80
+
81
+ </td><td>
82
+
83
+
84
+ </td><td>
85
+
86
+ (results: Result\[\]) =&gt; void
87
+
88
+
89
+ </td><td>
90
+
91
+ Requests and stores the enrichment results for the results.
92
+
93
+
94
+ </td></tr>
95
+ <tr><td>
96
+
97
+ [fetchBrowseResponse](./x-components.browseactions.fetchbrowseresponse.md)
98
+
99
+
100
+ </td><td>
101
+
102
+
103
+ </td><td>
104
+
105
+ (request: BrowseRequest) =&gt; BrowseResponse
106
+
107
+
108
+ </td><td>
109
+
110
+ Fetches the browse response and returns them.
111
+
112
+
113
+ </td></tr>
114
+ <tr><td>
115
+
116
+ [increasePageAppendingResults](./x-components.browseactions.increasepageappendingresults.md)
117
+
118
+
119
+ </td><td>
120
+
121
+
122
+ </td><td>
123
+
124
+ () =&gt; void
125
+
126
+
127
+ </td><td>
128
+
129
+ 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.
130
+
131
+
132
+ </td></tr>
133
+ <tr><td>
134
+
135
+ [resetRequestOnRefinement](./x-components.browseactions.resetrequestonrefinement.md)
136
+
137
+
138
+ </td><td>
139
+
140
+
141
+ </td><td>
142
+
143
+ (watchedRequest: [WatchedInternalBrowseRequest](./x-components.watchedinternalbrowserequest.md)<!-- -->) =&gt; void
144
+
145
+
146
+ </td><td>
147
+
148
+ Batches state resets in a single action after [BrowseGetters.request](./x-components.browsegetters.request.md) parameters update.
149
+
150
+
151
+ </td></tr>
152
+ <tr><td>
153
+
154
+ [saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)
155
+
156
+
157
+ </td><td>
158
+
159
+
160
+ </td><td>
161
+
162
+ (response: BrowseResponse) =&gt; void
163
+
164
+
165
+ </td><td>
166
+
167
+ Saves the [BrowseResponse](./x-types.browseresponse.md)<!-- -->.
168
+
169
+
170
+ </td></tr>
171
+ <tr><td>
172
+
173
+ [saveOrigin](./x-components.browseactions.saveorigin.md)
174
+
175
+
176
+ </td><td>
177
+
178
+
179
+ </td><td>
180
+
181
+ (originInit: [QueryOriginInit](./x-components.queryorigininit.md)<!-- -->) =&gt; void
182
+
183
+
184
+ </td><td>
185
+
186
+ Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it.
187
+
188
+
189
+ </td></tr>
190
+ <tr><td>
191
+
192
+ [setUrlParams](./x-components.browseactions.seturlparams.md)
193
+
194
+
195
+ </td><td>
196
+
197
+
198
+ </td><td>
199
+
200
+ (urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) =&gt; void
201
+
202
+
203
+ </td><td>
204
+
205
+ Checks if the url has params on it and then updates the state with these values.
206
+
207
+
208
+ </td></tr>
209
+ </tbody></table>
210
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [resetRequestOnRefinement](./x-components.browseactions.resetrequestonrefinement.md)
4
+
5
+ ## BrowseActions.resetRequestOnRefinement property
6
+
7
+ Batches state resets in a single action after [BrowseGetters.request](./x-components.browsegetters.request.md) parameters update.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ resetRequestOnRefinement: (watchedRequest: WatchedInternalBrowseRequest) => void;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)
4
+
5
+ ## BrowseActions.saveBrowseResponse property
6
+
7
+ Saves the [BrowseResponse](./x-types.browseresponse.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ saveBrowseResponse: (response: BrowseResponse) => void;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [saveOrigin](./x-components.browseactions.saveorigin.md)
4
+
5
+ ## BrowseActions.saveOrigin property
6
+
7
+ Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ saveOrigin: (originInit: QueryOriginInit) => void;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseActions](./x-components.browseactions.md) &gt; [setUrlParams](./x-components.browseactions.seturlparams.md)
4
+
5
+ ## BrowseActions.setUrlParams property
6
+
7
+ Checks if the url has params on it and then updates the state with these values.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setUrlParams: (urlParams: UrlParams) => void;
13
+ ```
@@ -0,0 +1,75 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseConfig](./x-components.browseconfig.md)
4
+
5
+ ## BrowseConfig interface
6
+
7
+ Configuration options for the [BrowseXModule](./x-components.browsexmodule.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface BrowseConfig
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ [pageMode](./x-components.browseconfig.pagemode.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ [PageMode](./x-components.pagemode.md)
49
+
50
+
51
+ </td><td>
52
+
53
+
54
+ </td></tr>
55
+ <tr><td>
56
+
57
+ [pageSize](./x-components.browseconfig.pagesize.md)
58
+
59
+
60
+ </td><td>
61
+
62
+
63
+ </td><td>
64
+
65
+ number
66
+
67
+
68
+ </td><td>
69
+
70
+ Maximum number of results to request.
71
+
72
+
73
+ </td></tr>
74
+ </tbody></table>
75
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseConfig](./x-components.browseconfig.md) &gt; [pageMode](./x-components.browseconfig.pagemode.md)
4
+
5
+ ## BrowseConfig.pageMode property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ pageMode: PageMode;
11
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseConfig](./x-components.browseconfig.md) &gt; [pageSize](./x-components.browseconfig.pagesize.md)
4
+
5
+ ## BrowseConfig.pageSize property
6
+
7
+ Maximum number of results to request.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ pageSize: number;
13
+ ```
@@ -0,0 +1,58 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseGetters](./x-components.browsegetters.md)
4
+
5
+ ## BrowseGetters interface
6
+
7
+ Browse store getters.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface BrowseGetters
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ [request](./x-components.browsegetters.request.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ [InternalBrowseRequest](./x-components.internalbrowserequest.md) \| null
49
+
50
+
51
+ </td><td>
52
+
53
+ The adapter request object for retrieving the results, or null if there is no valid data to create a request.
54
+
55
+
56
+ </td></tr>
57
+ </tbody></table>
58
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseGetters](./x-components.browsegetters.md) &gt; [request](./x-components.browsegetters.request.md)
4
+
5
+ ## BrowseGetters.request property
6
+
7
+ The adapter request object for retrieving the results, or null if there is no valid data to create a request.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ request: InternalBrowseRequest | null;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [appendResults](./x-components.browsemutations.appendresults.md)
4
+
5
+ ## BrowseMutations.appendResults property
6
+
7
+ Append the results to the results state.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ appendResults: (results: Result[]) => void;
13
+ ```