@empathyco/x-components 7.3.1 → 7.4.0

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 (113) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/docs/API-reference/api/x-components.basexapi.browse.md +54 -0
  3. package/docs/API-reference/api/x-components.basexapi.md +14 -0
  4. package/docs/API-reference/api/x-components.hierarchicalfilter.md +7 -0
  5. package/docs/API-reference/api/x-components.md +22 -0
  6. package/docs/API-reference/api/x-components.reseturlbrowsecategory.md +13 -0
  7. package/docs/API-reference/api/x-components.seturlbrowsecategory.md +13 -0
  8. package/docs/API-reference/api/x-components.simplefilter.md +7 -0
  9. package/docs/API-reference/api/x-components.snippetcallbacks.md +7 -0
  10. package/docs/API-reference/api/x-components.urlmutations.md +19 -0
  11. package/docs/API-reference/api/x-components.urlmutations.setbrowsecategory.md +13 -0
  12. package/docs/API-reference/api/x-components.urlparams.browsefield.md +11 -0
  13. package/docs/API-reference/api/x-components.urlparams.browsevalue.md +11 -0
  14. package/docs/API-reference/api/x-components.urlparams.md +34 -0
  15. package/docs/API-reference/api/x-components.usealiasapi.browsetotalresults.md +13 -0
  16. package/docs/API-reference/api/x-components.usealiasapi.md +21 -0
  17. package/docs/API-reference/api/x-components.xapi.browse.md +13 -0
  18. package/docs/API-reference/api/x-components.xapi.md +19 -0
  19. package/docs/API-reference/api/x-components.xeventstypes.md +2 -2
  20. package/docs/API-reference/api/x-components.xmodulestree.browse.md +11 -0
  21. package/docs/API-reference/api/x-components.xmodulestree.md +17 -0
  22. package/docs/API-reference/api/x-types.xcomponentsadapter.browse.md +11 -0
  23. package/docs/API-reference/api/x-types.xcomponentsadapter.md +17 -0
  24. package/docs/API-reference/components/browse/x-components.browse-results-list.md +21 -0
  25. package/docs/API-reference/components/browse/x-components.browse-sort-picker-list.md +24 -0
  26. package/js/composables/use-alias-api.js +3 -0
  27. package/js/composables/use-alias-api.js.map +1 -1
  28. package/js/index.js +1 -1
  29. package/js/x-installer/api/base-api.js +12 -0
  30. package/js/x-installer/api/base-api.js.map +1 -1
  31. package/js/x-modules/url/components/url-handler.vue.js.map +1 -1
  32. package/js/x-modules/url/components/url-handler.vue2.js +4 -1
  33. package/js/x-modules/url/components/url-handler.vue2.js.map +1 -1
  34. package/js/x-modules/url/store/initial-state.js +2 -0
  35. package/js/x-modules/url/store/initial-state.js.map +1 -1
  36. package/js/x-modules/url/store/module.js +4 -0
  37. package/js/x-modules/url/store/module.js.map +1 -1
  38. package/js/x-modules/url/wiring.js +34 -1
  39. package/js/x-modules/url/wiring.js.map +1 -1
  40. package/package.json +4 -4
  41. package/report/x-components.api.json +515 -5
  42. package/report/x-components.api.md +65 -3
  43. package/report/x-types.api.json +50 -0
  44. package/types/src/components/snippet-callbacks.vue.d.ts +7 -0
  45. package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
  46. package/types/src/composables/use-alias-api.d.ts +2 -0
  47. package/types/src/composables/use-alias-api.d.ts.map +1 -1
  48. package/types/src/types/url-params.d.ts +2 -0
  49. package/types/src/types/url-params.d.ts.map +1 -1
  50. package/types/src/wiring/events.types.d.ts +2 -1
  51. package/types/src/wiring/events.types.d.ts.map +1 -1
  52. package/types/src/x-installer/api/api.types.d.ts +9 -0
  53. package/types/src/x-installer/api/api.types.d.ts.map +1 -1
  54. package/types/src/x-installer/api/base-api.d.ts +9 -0
  55. package/types/src/x-installer/api/base-api.d.ts.map +1 -1
  56. package/types/src/x-modules/browse/components/index.d.ts +3 -0
  57. package/types/src/x-modules/browse/components/index.d.ts.map +1 -0
  58. package/types/src/x-modules/browse/config.types.d.ts +14 -0
  59. package/types/src/x-modules/browse/config.types.d.ts.map +1 -0
  60. package/types/src/x-modules/browse/events.types.d.ts +55 -0
  61. package/types/src/x-modules/browse/events.types.d.ts.map +1 -0
  62. package/types/src/x-modules/browse/index.d.ts +8 -0
  63. package/types/src/x-modules/browse/index.d.ts.map +1 -0
  64. package/types/src/x-modules/browse/store/actions/fetch-and-save-browse-response.action.d.ts +15 -0
  65. package/types/src/x-modules/browse/store/actions/fetch-and-save-browse-response.action.d.ts.map +1 -0
  66. package/types/src/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.d.ts +17 -0
  67. package/types/src/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.d.ts.map +1 -0
  68. package/types/src/x-modules/browse/store/actions/fetch-browse-response.action.d.ts +13 -0
  69. package/types/src/x-modules/browse/store/actions/fetch-browse-response.action.d.ts.map +1 -0
  70. package/types/src/x-modules/browse/store/actions/increase-page-apending-results.action.d.ts +11 -0
  71. package/types/src/x-modules/browse/store/actions/increase-page-apending-results.action.d.ts.map +1 -0
  72. package/types/src/x-modules/browse/store/actions/index.d.ts +9 -0
  73. package/types/src/x-modules/browse/store/actions/index.d.ts.map +1 -0
  74. package/types/src/x-modules/browse/store/actions/reset-request-on-refinement.action.d.ts +11 -0
  75. package/types/src/x-modules/browse/store/actions/reset-request-on-refinement.action.d.ts.map +1 -0
  76. package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts +11 -0
  77. package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts.map +1 -0
  78. package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts +11 -0
  79. package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts.map +1 -0
  80. package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts +11 -0
  81. package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts.map +1 -0
  82. package/types/src/x-modules/browse/store/emitters.d.ts +35 -0
  83. package/types/src/x-modules/browse/store/emitters.d.ts.map +1 -0
  84. package/types/src/x-modules/browse/store/getters/index.d.ts +2 -0
  85. package/types/src/x-modules/browse/store/getters/index.d.ts.map +1 -0
  86. package/types/src/x-modules/browse/store/getters/request.getter.d.ts +13 -0
  87. package/types/src/x-modules/browse/store/getters/request.getter.d.ts.map +1 -0
  88. package/types/src/x-modules/browse/store/index.d.ts +6 -0
  89. package/types/src/x-modules/browse/store/index.d.ts.map +1 -0
  90. package/types/src/x-modules/browse/store/module.d.ts +41 -0
  91. package/types/src/x-modules/browse/store/module.d.ts.map +1 -0
  92. package/types/src/x-modules/browse/store/types.d.ts +273 -0
  93. package/types/src/x-modules/browse/store/types.d.ts.map +1 -0
  94. package/types/src/x-modules/browse/types.d.ts +35 -0
  95. package/types/src/x-modules/browse/types.d.ts.map +1 -0
  96. package/types/src/x-modules/browse/wiring.d.ts +172 -0
  97. package/types/src/x-modules/browse/wiring.d.ts.map +1 -0
  98. package/types/src/x-modules/browse/x-module.d.ts +16 -0
  99. package/types/src/x-modules/browse/x-module.d.ts.map +1 -0
  100. package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +7 -0
  101. package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
  102. package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts +7 -0
  103. package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
  104. package/types/src/x-modules/url/components/url-handler.vue.d.ts.map +1 -1
  105. package/types/src/x-modules/url/store/initial-state.d.ts.map +1 -1
  106. package/types/src/x-modules/url/store/module.d.ts.map +1 -1
  107. package/types/src/x-modules/url/store/types.d.ts +7 -1
  108. package/types/src/x-modules/url/store/types.d.ts.map +1 -1
  109. package/types/src/x-modules/url/wiring.d.ts +30 -0
  110. package/types/src/x-modules/url/wiring.d.ts.map +1 -1
  111. package/types/src/x-modules/x-modules.types.d.ts +2 -0
  112. package/types/src/x-modules/x-modules.types.d.ts.map +1 -1
  113. package/url/index.js +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,13 @@
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.0](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.1...@empathyco/x-components@7.4.0) (2026-07-07)
7
+
8
+ ### Features
9
+
10
+ * create browse module (#2128)
11
+
12
+
6
13
  ## [7.3.1](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.0...@empathyco/x-components@7.3.1) (2026-07-06)
7
14
 
8
15
  ### Bug Fixes
@@ -0,0 +1,54 @@
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; [BaseXAPI](./x-components.basexapi.md) &gt; [browse](./x-components.basexapi.browse.md)
4
+
5
+ ## BaseXAPI.browse() method
6
+
7
+ Browses the browseField and browseValue parameters as a selected category.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ browse(browseCategory?: BrowsableRequest): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ browseCategory
36
+
37
+
38
+ </td><td>
39
+
40
+ BrowsableRequest
41
+
42
+
43
+ </td><td>
44
+
45
+ _(Optional)_ browseField and browseValue to be browsed.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+
51
+ **Returns:**
52
+
53
+ void
54
+
@@ -88,6 +88,20 @@ Description
88
88
  Tracks that a product was added to cart from PDP.
89
89
 
90
90
 
91
+ </td></tr>
92
+ <tr><td>
93
+
94
+ [browse(browseCategory)](./x-components.basexapi.browse.md)
95
+
96
+
97
+ </td><td>
98
+
99
+
100
+ </td><td>
101
+
102
+ Browses the browseField and browseValue parameters as a selected category.
103
+
104
+
91
105
  </td></tr>
92
106
  <tr><td>
93
107
 
@@ -169,6 +169,13 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
169
169
  UserClickedABanner?: import("@empathyco/x-types").Banner | undefined;
170
170
  UserClickedAbortARedirection?: void | undefined;
171
171
  UserSelectedAPage?: number | undefined;
172
+ BrowseRequestChanged?: import("../../../browse").InternalBrowseRequest | null | undefined;
173
+ BrowseRequestUpdated?: import("../../../browse").InternalBrowseRequest | null | undefined;
174
+ BrowseResponseChanged?: import("../../../browse").InternalBrowseResponse | undefined;
175
+ BrowseTaggingChanged?: import("@empathyco/x-types").TaggingRequest | undefined;
176
+ UserClickedABrowseSort?: string | undefined;
177
+ SelectedBrowseSortProvided?: string | undefined;
178
+ UserBrowsedToCategory?: import("@empathyco/x-types").BrowsableRequest | undefined;
172
179
  SemanticQueryRequestUpdated?: import("@empathyco/x-types").SemanticQueriesRequest | null | undefined;
173
180
  SemanticQueriesResponseChanged?: import("@empathyco/x-types").SemanticQuery[] | undefined;
174
181
  UserSelectedASemanticQuery?: import("@empathyco/x-types").SemanticQuery | undefined;
@@ -5956,6 +5956,17 @@ Resets the search state to reload the current search.
5956
5956
  Resets the search state when the request is changed to null. See the [SearchXStoreModule](./x-components.searchxstoremodule.md) for details.
5957
5957
 
5958
5958
 
5959
+ </td></tr>
5960
+ <tr><td>
5961
+
5962
+ [resetUrlBrowseCategory](./x-components.reseturlbrowsecategory.md)
5963
+
5964
+
5965
+ </td><td>
5966
+
5967
+ Sets the browseCategory of the url module.
5968
+
5969
+
5959
5970
  </td></tr>
5960
5971
  <tr><td>
5961
5972
 
@@ -7004,6 +7015,17 @@ Sets the total results taking the [SearchXEvents.SearchResponseChanged](./x-comp
7004
7015
  Sets the total results.
7005
7016
 
7006
7017
 
7018
+ </td></tr>
7019
+ <tr><td>
7020
+
7021
+ [setUrlBrowseCategory](./x-components.seturlbrowsecategory.md)
7022
+
7023
+
7024
+ </td><td>
7025
+
7026
+ Sets the browseCategory of the url module.
7027
+
7028
+
7007
7029
  </td></tr>
7008
7030
  <tr><td>
7009
7031
 
@@ -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; [resetUrlBrowseCategory](./x-components.reseturlbrowsecategory.md)
4
+
5
+ ## resetUrlBrowseCategory variable
6
+
7
+ Sets the browseCategory of the url module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ resetUrlBrowseCategory: import("../..").AnyWire
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; [setUrlBrowseCategory](./x-components.seturlbrowsecategory.md)
4
+
5
+ ## setUrlBrowseCategory variable
6
+
7
+ Sets the browseCategory of the url module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setUrlBrowseCategory: import("../..").Wire<import("@empathyco/x-types").BrowsableRequest>
13
+ ```
@@ -166,6 +166,13 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
166
166
  UserClickedABanner?: import("@empathyco/x-types").Banner | undefined;
167
167
  UserClickedAbortARedirection?: void | undefined;
168
168
  UserSelectedAPage?: number | undefined;
169
+ BrowseRequestChanged?: import("../../../browse").InternalBrowseRequest | null | undefined;
170
+ BrowseRequestUpdated?: import("../../../browse").InternalBrowseRequest | null | undefined;
171
+ BrowseResponseChanged?: import("../../../browse").InternalBrowseResponse | undefined;
172
+ BrowseTaggingChanged?: import("@empathyco/x-types").TaggingRequest | undefined;
173
+ UserClickedABrowseSort?: string | undefined;
174
+ SelectedBrowseSortProvided?: string | undefined;
175
+ UserBrowsedToCategory?: import("@empathyco/x-types").BrowsableRequest | undefined;
169
176
  SemanticQueryRequestUpdated?: import("@empathyco/x-types").SemanticQueriesRequest | null | undefined;
170
177
  SemanticQueriesResponseChanged?: import("@empathyco/x-types").SemanticQuery[] | undefined;
171
178
  UserSelectedASemanticQuery?: import("@empathyco/x-types").SemanticQuery | undefined;
@@ -156,6 +156,13 @@ _default: import("vue").DefineComponent<{}, {
156
156
  UserClickedABanner: (payload: import("@empathyco/x-types").Banner, metadata: WireMetadata) => unknown;
157
157
  UserClickedAbortARedirection: (payload: undefined, metadata: WireMetadata) => unknown;
158
158
  UserSelectedAPage: (payload: number, metadata: WireMetadata) => unknown;
159
+ BrowseRequestChanged: (payload: import("../x-modules/browse").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
160
+ BrowseRequestUpdated: (payload: import("../x-modules/browse").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
161
+ BrowseResponseChanged: (payload: import("../x-modules/browse").InternalBrowseResponse, metadata: WireMetadata) => unknown;
162
+ BrowseTaggingChanged: (payload: import("@empathyco/x-types").TaggingRequest, metadata: WireMetadata) => unknown;
163
+ UserClickedABrowseSort: (payload: string, metadata: WireMetadata) => unknown;
164
+ SelectedBrowseSortProvided: (payload: string, metadata: WireMetadata) => unknown;
165
+ UserBrowsedToCategory: (payload: import("@empathyco/x-types").BrowsableRequest, metadata: WireMetadata) => unknown;
159
166
  SemanticQueryRequestUpdated: (payload: import("@empathyco/x-types").SemanticQueriesRequest | null, metadata: WireMetadata) => unknown;
160
167
  SemanticQueriesResponseChanged: (payload: import("@empathyco/x-types").SemanticQuery[], metadata: WireMetadata) => unknown;
161
168
  UserSelectedASemanticQuery: (payload: import("@empathyco/x-types").SemanticQuery, metadata: WireMetadata) => unknown;
@@ -38,6 +38,25 @@ Description
38
38
  </th></tr></thead>
39
39
  <tbody><tr><td>
40
40
 
41
+ [setBrowseCategory](./x-components.urlmutations.setbrowsecategory.md)
42
+
43
+
44
+ </td><td>
45
+
46
+
47
+ </td><td>
48
+
49
+ (browseCategory: BrowsableRequest) =&gt; void
50
+
51
+
52
+ </td><td>
53
+
54
+ Sets the new browseCategory.
55
+
56
+
57
+ </td></tr>
58
+ <tr><td>
59
+
41
60
  [setFilters](./x-components.urlmutations.setfilters.md)
42
61
 
43
62
 
@@ -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; [UrlMutations](./x-components.urlmutations.md) &gt; [setBrowseCategory](./x-components.urlmutations.setbrowsecategory.md)
4
+
5
+ ## UrlMutations.setBrowseCategory property
6
+
7
+ Sets the new browseCategory.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setBrowseCategory: (browseCategory: BrowsableRequest) => void;
13
+ ```
@@ -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; [UrlParams](./x-components.urlparams.md) &gt; [browseField](./x-components.urlparams.browsefield.md)
4
+
5
+ ## UrlParams.browseField property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ browseField: string;
11
+ ```
@@ -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; [UrlParams](./x-components.urlparams.md) &gt; [browseValue](./x-components.urlparams.browsevalue.md)
4
+
5
+ ## UrlParams.browseValue property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ browseValue: string;
11
+ ```
@@ -37,6 +37,40 @@ Description
37
37
  </th></tr></thead>
38
38
  <tbody><tr><td>
39
39
 
40
+ [browseField](./x-components.urlparams.browsefield.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ string
49
+
50
+
51
+ </td><td>
52
+
53
+
54
+ </td></tr>
55
+ <tr><td>
56
+
57
+ [browseValue](./x-components.urlparams.browsevalue.md)
58
+
59
+
60
+ </td><td>
61
+
62
+
63
+ </td><td>
64
+
65
+ string
66
+
67
+
68
+ </td><td>
69
+
70
+
71
+ </td></tr>
72
+ <tr><td>
73
+
40
74
  [filter](./x-components.urlparams.filter.md)
41
75
 
42
76
 
@@ -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; [UseAliasAPI](./x-components.usealiasapi.md) &gt; [browseTotalResults](./x-components.usealiasapi.browsetotalresults.md)
4
+
5
+ ## UseAliasAPI.browseTotalResults property
6
+
7
+ The total results.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ readonly browseTotalResults: number;
13
+ ```
@@ -37,6 +37,27 @@ Description
37
37
  </th></tr></thead>
38
38
  <tbody><tr><td>
39
39
 
40
+ [browseTotalResults](./x-components.usealiasapi.browsetotalresults.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ `readonly`
46
+
47
+
48
+ </td><td>
49
+
50
+ number
51
+
52
+
53
+ </td><td>
54
+
55
+ The total results.
56
+
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
40
61
  [device](./x-components.usealiasapi.device.md)
41
62
 
42
63
 
@@ -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; [XAPI](./x-components.xapi.md) &gt; [browse](./x-components.xapi.browse.md)
4
+
5
+ ## XAPI.browse property
6
+
7
+ Dispatch a browse with the browseCategory parameter.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ browse: (browseCategory?: BrowsableRequest) => void;
13
+ ```
@@ -53,6 +53,25 @@ Description
53
53
  To track that a product was added to the cart from PDP.
54
54
 
55
55
 
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ [browse](./x-components.xapi.browse.md)
60
+
61
+
62
+ </td><td>
63
+
64
+
65
+ </td><td>
66
+
67
+ (browseCategory?: BrowsableRequest) =&gt; void
68
+
69
+
70
+ </td><td>
71
+
72
+ Dispatch a browse with the browseCategory parameter.
73
+
74
+
56
75
  </td></tr>
57
76
  <tr><td>
58
77
 
@@ -9,9 +9,9 @@
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents, RelatedPromptsXEvents, AiXEvents
12
+ export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, BrowseXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents, RelatedPromptsXEvents, AiXEvents
13
13
  ```
14
- **Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)<!-- -->, [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)<!-- -->, [AiXEvents](./x-components.aixevents.md)
14
+ **Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, BrowseXEvents, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)<!-- -->, [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)<!-- -->, [AiXEvents](./x-components.aixevents.md)
15
15
 
16
16
  ## Remarks
17
17
 
@@ -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; [XModulesTree](./x-components.xmodulestree.md) &gt; [browse](./x-components.xmodulestree.browse.md)
4
+
5
+ ## XModulesTree.browse property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ browse: BrowseXModule;
11
+ ```
@@ -51,6 +51,23 @@ Description
51
51
  </td><td>
52
52
 
53
53
 
54
+ </td></tr>
55
+ <tr><td>
56
+
57
+ [browse](./x-components.xmodulestree.browse.md)
58
+
59
+
60
+ </td><td>
61
+
62
+
63
+ </td><td>
64
+
65
+ BrowseXModule
66
+
67
+
68
+ </td><td>
69
+
70
+
54
71
  </td></tr>
55
72
  <tr><td>
56
73
 
@@ -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-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [browse](./x-types.xcomponentsadapter.browse.md)
4
+
5
+ ## XComponentsAdapter.browse property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ browse: EndpointAdapter<BrowseRequest, BrowseResponse>;
11
+ ```
@@ -68,6 +68,23 @@ EndpointAdapter&lt;[AiSuggestionsSearchRequest](./x-types.aisuggestionssearchreq
68
68
  </td><td>
69
69
 
70
70
 
71
+ </td></tr>
72
+ <tr><td>
73
+
74
+ [browse](./x-types.xcomponentsadapter.browse.md)
75
+
76
+
77
+ </td><td>
78
+
79
+
80
+ </td><td>
81
+
82
+ EndpointAdapter&lt;[BrowseRequest](./x-types.browserequest.md)<!-- -->, [BrowseResponse](./x-types.browseresponse.md)<!-- -->&gt;
83
+
84
+
85
+ </td><td>
86
+
87
+
71
88
  </td></tr>
72
89
  <tr><td>
73
90
 
@@ -0,0 +1,21 @@
1
+ ---
2
+
3
+ title: BrowseResultsList
4
+
5
+ ---
6
+
7
+ # BrowseResultsList
8
+
9
+ It renders a ItemsList list with the results from SearchState.results by
10
+ default.
11
+
12
+ The component provides a default slot which wraps the whole component with the `results` bound.
13
+
14
+ It also provides the slot result to customize the item, which is within the default slot, with
15
+ the result bound.
16
+
17
+ ## Props
18
+
19
+ | Name | Description | Type | Default |
20
+ | ---------------------- | ------------------------------------------------------------- | -------------------------- | ----------------- |
21
+ | <code>animation</code> | Animation component that will be used to animate the results. | <code>AnimationProp</code> | <code>'ul'</code> |
@@ -0,0 +1,24 @@
1
+ ---
2
+
3
+ title: BrowseSortPickerList
4
+
5
+ ---
6
+
7
+ # BrowseSortPickerList
8
+
9
+ The `SortPickerList` component allows user to select the browse results order. This component
10
+ also allows to change the selected sort programmatically.
11
+
12
+ ## Props
13
+
14
+ | Name | Description | Type | Default |
15
+ | ------------------------ | ----------- | ------------------- | ----------------- |
16
+ | <code>animation</code> | | <code>union</code> | <code>'ul'</code> |
17
+ | <code>items</code> | | <code>Array</code> | <code></code> |
18
+ | <code>buttonClass</code> | | <code>string</code> | <code></code> |
19
+
20
+ ## Slots
21
+
22
+ | Name | Description | Bindings<br />(name - type - description) |
23
+ | -------------------- | ----------- | ----------------------------------------- |
24
+ | <code>default</code> | | <br /> |
@@ -138,6 +138,9 @@ function useAliasApi() {
138
138
  get totalResults() {
139
139
  return store.state.x.search?.totalResults ?? 0;
140
140
  },
141
+ get browseTotalResults() {
142
+ return store.state.x.browse?.totalResults ?? 0;
143
+ },
141
144
  get selectedSort() {
142
145
  return store.state.x.search?.sort ?? '';
143
146
  },
@@ -1 +1 @@
1
- {"version":3,"file":"use-alias-api.js","sources":["../../../src/composables/use-alias-api.ts"],"sourcesContent":["import type {\n Facet,\n Filter,\n HistoryQuery,\n NextQuery,\n PartialResult,\n Redirection,\n RelatedPrompt,\n RelatedTag,\n Result,\n SemanticQuery,\n Suggestion,\n} from '@empathyco/x-types'\nimport type { RequestStatus } from '../store/utils/status-store.utils'\nimport type { ScrollComponentState } from '../x-modules/scroll/store/types'\nimport type { InputStatus } from '../x-modules/search-box/store/types'\nimport { useStore } from 'vuex'\nimport { getGetterPath } from '../plugins/index'\n\n/* eslint-disable ts/no-unsafe-return,ts/no-unsafe-member-access,ts/no-unsafe-assignment */\n\n/**\n * Creates an object containing the alias part of {@link XComponentAPI}.\n *\n * @returns An object containing the alias part of the {@link XComponentAPI}.\n *\n * @internal\n */\nexport function useAliasApi(): UseAliasAPI {\n const queryModules = [\n 'facets',\n 'searchBox',\n 'nextQueries',\n 'querySuggestions',\n 'relatedTags',\n 'search',\n ] as const\n const statusModules = [\n 'identifierResults',\n 'nextQueries',\n 'popularSearches',\n 'querySuggestions',\n 'recommendations',\n 'relatedTags',\n 'search',\n ] as const\n\n const store = useStore()\n\n const query = queryModules.reduce((acc, moduleName) => {\n return Object.defineProperty(acc, moduleName, {\n get(): string {\n return store.state.x[moduleName]?.query ?? ''\n },\n enumerable: true,\n })\n }, {} as UseAliasQueryAPI)\n\n const status = statusModules.reduce((acc, moduleName) => {\n return Object.defineProperty(acc, moduleName, {\n get(): RequestStatus | undefined {\n return store.state.x[moduleName]?.status\n },\n enumerable: true,\n })\n }, {} as UseAliasStatusAPI)\n\n return {\n query,\n status,\n get device() {\n return store.state.x.device?.name ?? null\n },\n get facets() {\n return store.getters[getGetterPath('facets', 'facets')] ?? {}\n },\n get historyQueries() {\n return store.getters[getGetterPath('historyQueries', 'historyQueries')] ?? []\n },\n get historyQueriesWithResults() {\n return store.getters[getGetterPath('historyQueries', 'historyQueriesWithResults')] ?? []\n },\n get fullHistoryQueries() {\n return store.state.x.historyQueries?.historyQueries ?? []\n },\n get isHistoryQueriesEnabled() {\n return store.state.x.historyQueries?.isEnabled ?? false\n },\n get fromNoResultsWithFilters() {\n return store.state.x.search?.fromNoResultsWithFilters ?? false\n },\n get identifierResults() {\n return store.state.x.identifierResults?.identifierResults ?? []\n },\n get searchBoxStatus() {\n return store.state.x.searchBox?.inputStatus ?? undefined\n },\n get isEmpathizeOpen() {\n return store.state.x.empathize?.isOpen ?? false\n },\n get nextQueries() {\n return store.getters[getGetterPath('nextQueries', 'nextQueries')] ?? []\n },\n get noResults() {\n return store.state.x.search?.isNoResults ?? false\n },\n get lowResults() {\n return (\n store.state.x.search?.totalResults > 0 &&\n store.state.x.search?.totalResults < store.state.x.search?.config?.threshold\n )\n },\n get partialResults() {\n return store.state.x.search?.partialResults ?? []\n },\n get popularSearches() {\n return store.state.x.popularSearches?.popularSearches ?? []\n },\n get querySuggestions() {\n return store.getters[getGetterPath('querySuggestions', 'querySuggestions')] ?? []\n },\n get fullQuerySuggestions() {\n return store.state.x.querySuggestions?.suggestions ?? []\n },\n get recommendations() {\n return store.state.x.recommendations?.recommendations ?? []\n },\n get redirections() {\n return store.state.x.search?.redirections ?? []\n },\n get relatedTags() {\n return store.getters[getGetterPath('relatedTags', 'relatedTags')] ?? []\n },\n get results() {\n return store.state.x.search?.results ?? []\n },\n get scroll() {\n return store.state.x.scroll?.data ?? {}\n },\n get selectedFilters() {\n return store.getters[getGetterPath('facets', 'selectedFilters')] ?? []\n },\n get selectedRelatedTags() {\n return store.state.x.relatedTags?.selectedRelatedTags ?? []\n },\n get selectedPrompt() {\n return store.state.x.relatedPrompts?.selectedPrompt ?? -1\n },\n get semanticQueries() {\n return store.state.x.semanticQueries?.semanticQueries ?? []\n },\n get relatedPrompts() {\n return store.state.x.relatedPrompts?.relatedPrompts ?? []\n },\n get spellcheckedQuery() {\n return store.state.x.search?.spellcheckedQuery ?? null\n },\n get totalResults() {\n return store.state.x.search?.totalResults ?? 0\n },\n get selectedSort() {\n return store.state.x.search?.sort ?? ''\n },\n get priceStats() {\n return store.state.x.search?.stats?.price ?? {}\n },\n }\n}\n\n/**\n * Alias to facilitate retrieving values from the store.\n *\n * @public\n */\nexport interface UseAliasAPI {\n /** The {@link DeviceXModule} detected device. */\n readonly device: string | null\n /** The {@link FacetsXModule} facets. */\n readonly facets: Record<Facet['id'], Facet>\n /** The {@link HistoryQueriesXModule} history queries matching the query. */\n readonly historyQueries: ReadonlyArray<HistoryQuery>\n /** The {@link HistoryQueriesXModule} history queries with 1 or more results. */\n readonly historyQueriesWithResults: ReadonlyArray<HistoryQuery>\n /** The {@link HistoryQueriesXModule} history queries. */\n readonly fullHistoryQueries: ReadonlyArray<HistoryQuery>\n /** The {@link HistoryQueriesXModule} history queries enabled flag. */\n readonly isHistoryQueriesEnabled: Readonly<boolean>\n /** The {@link SearchXModule} no results with filters flag. */\n readonly fromNoResultsWithFilters: Readonly<boolean>\n /** The {@link IdentifierResultsXModule} results. */\n readonly identifierResults: ReadonlyArray<Result>\n /** The {@link SearchBoxXModule } input status. */\n readonly searchBoxStatus: InputStatus | undefined\n /** The {@link Empathize} is open state. */\n readonly isEmpathizeOpen: boolean\n /** The {@link NextQueriesXModule} next queries. */\n readonly nextQueries: ReadonlyArray<NextQuery>\n /** The {@link SearchXModule} no results situation. */\n readonly noResults: boolean\n /** The {@link SearchXModule} low results situation. */\n readonly lowResults: boolean\n /** The {@link SearchXModule} partial results. */\n readonly partialResults: ReadonlyArray<PartialResult>\n /** The {@link PopularSearchesXModule} popular searches. */\n readonly popularSearches: ReadonlyArray<Suggestion>\n /** The query value of the different modules. */\n readonly query: UseAliasQueryAPI\n /** The {@link QuerySuggestionsXModule} query suggestions that should be displayed. */\n readonly querySuggestions: ReadonlyArray<Suggestion>\n /** The {@link QuerySuggestionsXModule} query suggestions. */\n readonly fullQuerySuggestions: ReadonlyArray<Suggestion>\n /** The {@link RecommendationsXModule} recommendations. */\n readonly recommendations: ReadonlyArray<Result>\n /** The {@link SearchXModule} redirections. */\n readonly redirections: ReadonlyArray<Redirection>\n /** The {@link RelatedTagsXModule} related tags (Both selected and deselected). */\n readonly relatedTags: ReadonlyArray<RelatedTag>\n /** The {@link SearchXModule} search results. */\n readonly results: ReadonlyArray<Result>\n /** The {@link ScrollXModule} data state. */\n readonly scroll: Record<string, ScrollComponentState>\n /** The {@link FacetsXModule} selected filters. */\n readonly selectedFilters: Filter[]\n /** The {@link RelatedTagsXModule} selected related tags. */\n readonly selectedRelatedTags: ReadonlyArray<RelatedTag>\n /** The {@link RelatedPromptsXModule} selected prompt. */\n readonly selectedPrompt: number\n /** The {@link SemanticQueriesXModule} queries. */\n readonly semanticQueries: ReadonlyArray<SemanticQuery>\n /** The {@link RelatedPromptsXModule} related prompts. */\n readonly relatedPrompts: ReadonlyArray<RelatedPrompt>\n /** The {@link SearchXModule} spellchecked query. */\n readonly spellcheckedQuery: string | null\n /** The status value of the different modules. */\n readonly status: UseAliasStatusAPI\n /** The {@link SearchXModule} total results. */\n readonly totalResults: number\n /** The {@link SearchXModule} selected sort. */\n readonly selectedSort: string\n /** The {@link SearchXModule} price specific stats. */\n readonly priceStats: { min: number; max: number }\n}\n\n/**\n * Alias to facilitate retrieving the modules with query.\n *\n * @public\n */\nexport interface UseAliasQueryAPI {\n /** The {@link FacetsXModule} query. */\n readonly facets: string\n /** The {@link SearchBoxXModule} query. */\n readonly searchBox: string\n /** The {@link NextQueriesXModule} query. */\n readonly nextQueries: string\n /** The {@link QuerySuggestionsXModule} query. */\n readonly querySuggestions: string\n /** The {@link RelatedTagsXModule} query. */\n readonly relatedTags: string\n /** The {@link SearchXModule} query. */\n readonly search: string\n}\n\n/**\n * Alias to facilitate retrieving the modules with status.\n *\n * @public\n */\nexport interface UseAliasStatusAPI {\n /** The {@link IdentifierResultsXModule} status. */\n readonly identifierResults: RequestStatus | undefined\n /** The {@link NextQueriesXModule} status. */\n readonly nextQueries: RequestStatus | undefined\n /** The {@link PopularSearchesXModule} status. */\n readonly popularSearches: RequestStatus | undefined\n /** The {@link QuerySuggestionsXModule} status. */\n readonly querySuggestions: RequestStatus | undefined\n /** The {@link RecommendationsXModule} status. */\n readonly recommendations: RequestStatus | undefined\n /** The {@link RelatedTagsXModule} status. */\n readonly relatedTags: RequestStatus | undefined\n /** The {@link SearchXModule} status. */\n readonly search: RequestStatus | undefined\n}\n\n/* eslint-enable ts/no-unsafe-return,ts/no-unsafe-member-access,ts/no-unsafe-assignment */\n"],"names":[],"mappings":";;;;;;AAmBA;AAEA;;;;;;AAMG;SACa,WAAW,GAAA;AACzB,IAAA,MAAM,YAAY,GAAG;QACnB,QAAQ;QACR,WAAW;QACX,aAAa;QACb,kBAAkB;QAClB,aAAa;QACb,QAAQ;KACA;AACV,IAAA,MAAM,aAAa,GAAG;QACpB,mBAAmB;QACnB,aAAa;QACb,iBAAiB;QACjB,kBAAkB;QAClB,iBAAiB;QACjB,aAAa;QACb,QAAQ;KACA;AAEV,IAAA,MAAM,KAAK,GAAG,QAAQ,EAAE;IAExB,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,KAAI;AACpD,QAAA,OAAO,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE;YAC5C,GAAG,GAAA;AACD,gBAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,IAAI,EAAE;YAC/C,CAAC;AACD,YAAA,UAAU,EAAE,IAAI;AACjB,SAAA,CAAC;IACJ,CAAC,EAAE,EAAsB,CAAC;IAE1B,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,KAAI;AACtD,QAAA,OAAO,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE;YAC5C,GAAG,GAAA;gBACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM;YAC1C,CAAC;AACD,YAAA,UAAU,EAAE,IAAI;AACjB,SAAA,CAAC;IACJ,CAAC,EAAE,EAAuB,CAAC;IAE3B,OAAO;QACL,KAAK;QACL,MAAM;AACN,QAAA,IAAI,MAAM,GAAA;YACR,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI;QAC3C,CAAC;AACD,QAAA,IAAI,MAAM,GAAA;AACR,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE;QAC/D,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;AAChB,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,IAAI,EAAE;QAC/E,CAAC;AACD,QAAA,IAAI,yBAAyB,GAAA;AAC3B,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAE,2BAA2B,CAAC,CAAC,IAAI,EAAE;QAC1F,CAAC;AACD,QAAA,IAAI,kBAAkB,GAAA;YACpB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,cAAc,IAAI,EAAE;QAC3D,CAAC;AACD,QAAA,IAAI,uBAAuB,GAAA;YACzB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,SAAS,IAAI,KAAK;QACzD,CAAC;AACD,QAAA,IAAI,wBAAwB,GAAA;YAC1B,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,wBAAwB,IAAI,KAAK;QAChE,CAAC;AACD,QAAA,IAAI,iBAAiB,GAAA;YACnB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,iBAAiB,EAAE,iBAAiB,IAAI,EAAE;QACjE,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,WAAW,IAAI,SAAS;QAC1D,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,IAAI,KAAK;QACjD,CAAC;AACD,QAAA,IAAI,WAAW,GAAA;AACb,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,IAAI,EAAE;QACzE,CAAC;AACD,QAAA,IAAI,SAAS,GAAA;YACX,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,IAAI,KAAK;QACnD,CAAC;AACD,QAAA,IAAI,UAAU,GAAA;YACZ,QACE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,GAAG,CAAC;gBACtC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS;QAEhF,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;YAChB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,cAAc,IAAI,EAAE;QACnD,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,EAAE,eAAe,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,gBAAgB,GAAA;AAClB,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,IAAI,EAAE;QACnF,CAAC;AACD,QAAA,IAAI,oBAAoB,GAAA;YACtB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,gBAAgB,EAAE,WAAW,IAAI,EAAE;QAC1D,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,EAAE,eAAe,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,IAAI,EAAE;QACjD,CAAC;AACD,QAAA,IAAI,WAAW,GAAA;AACb,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,IAAI,EAAE;QACzE,CAAC;AACD,QAAA,IAAI,OAAO,GAAA;YACT,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE;QAC5C,CAAC;AACD,QAAA,IAAI,MAAM,GAAA;YACR,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE;QACzC,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;AACjB,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,IAAI,EAAE;QACxE,CAAC;AACD,QAAA,IAAI,mBAAmB,GAAA;YACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,mBAAmB,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;AAChB,YAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,cAAc,IAAI,EAAE;QAC3D,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,EAAE,eAAe,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;YAChB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,cAAc,IAAI,EAAE;QAC3D,CAAC;AACD,QAAA,IAAI,iBAAiB,GAAA;YACnB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,iBAAiB,IAAI,IAAI;QACxD,CAAC;AACD,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,IAAI,CAAC;QAChD,CAAC;AACD,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE;QACzC,CAAC;AACD,QAAA,IAAI,UAAU,GAAA;AACZ,YAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE;QACjD,CAAC;KACF;AACH;AAsHA;;;;"}
1
+ {"version":3,"file":"use-alias-api.js","sources":["../../../src/composables/use-alias-api.ts"],"sourcesContent":["import type {\n Facet,\n Filter,\n HistoryQuery,\n NextQuery,\n PartialResult,\n Redirection,\n RelatedPrompt,\n RelatedTag,\n Result,\n SemanticQuery,\n Suggestion,\n} from '@empathyco/x-types'\nimport type { RequestStatus } from '../store/utils/status-store.utils'\nimport type { ScrollComponentState } from '../x-modules/scroll/store/types'\nimport type { InputStatus } from '../x-modules/search-box/store/types'\nimport { useStore } from 'vuex'\nimport { getGetterPath } from '../plugins/index'\n\n/* eslint-disable ts/no-unsafe-return,ts/no-unsafe-member-access,ts/no-unsafe-assignment */\n\n/**\n * Creates an object containing the alias part of {@link XComponentAPI}.\n *\n * @returns An object containing the alias part of the {@link XComponentAPI}.\n *\n * @internal\n */\nexport function useAliasApi(): UseAliasAPI {\n const queryModules = [\n 'facets',\n 'searchBox',\n 'nextQueries',\n 'querySuggestions',\n 'relatedTags',\n 'search',\n ] as const\n const statusModules = [\n 'identifierResults',\n 'nextQueries',\n 'popularSearches',\n 'querySuggestions',\n 'recommendations',\n 'relatedTags',\n 'search',\n ] as const\n\n const store = useStore()\n\n const query = queryModules.reduce((acc, moduleName) => {\n return Object.defineProperty(acc, moduleName, {\n get(): string {\n return store.state.x[moduleName]?.query ?? ''\n },\n enumerable: true,\n })\n }, {} as UseAliasQueryAPI)\n\n const status = statusModules.reduce((acc, moduleName) => {\n return Object.defineProperty(acc, moduleName, {\n get(): RequestStatus | undefined {\n return store.state.x[moduleName]?.status\n },\n enumerable: true,\n })\n }, {} as UseAliasStatusAPI)\n\n return {\n query,\n status,\n get device() {\n return store.state.x.device?.name ?? null\n },\n get facets() {\n return store.getters[getGetterPath('facets', 'facets')] ?? {}\n },\n get historyQueries() {\n return store.getters[getGetterPath('historyQueries', 'historyQueries')] ?? []\n },\n get historyQueriesWithResults() {\n return store.getters[getGetterPath('historyQueries', 'historyQueriesWithResults')] ?? []\n },\n get fullHistoryQueries() {\n return store.state.x.historyQueries?.historyQueries ?? []\n },\n get isHistoryQueriesEnabled() {\n return store.state.x.historyQueries?.isEnabled ?? false\n },\n get fromNoResultsWithFilters() {\n return store.state.x.search?.fromNoResultsWithFilters ?? false\n },\n get identifierResults() {\n return store.state.x.identifierResults?.identifierResults ?? []\n },\n get searchBoxStatus() {\n return store.state.x.searchBox?.inputStatus ?? undefined\n },\n get isEmpathizeOpen() {\n return store.state.x.empathize?.isOpen ?? false\n },\n get nextQueries() {\n return store.getters[getGetterPath('nextQueries', 'nextQueries')] ?? []\n },\n get noResults() {\n return store.state.x.search?.isNoResults ?? false\n },\n get lowResults() {\n return (\n store.state.x.search?.totalResults > 0 &&\n store.state.x.search?.totalResults < store.state.x.search?.config?.threshold\n )\n },\n get partialResults() {\n return store.state.x.search?.partialResults ?? []\n },\n get popularSearches() {\n return store.state.x.popularSearches?.popularSearches ?? []\n },\n get querySuggestions() {\n return store.getters[getGetterPath('querySuggestions', 'querySuggestions')] ?? []\n },\n get fullQuerySuggestions() {\n return store.state.x.querySuggestions?.suggestions ?? []\n },\n get recommendations() {\n return store.state.x.recommendations?.recommendations ?? []\n },\n get redirections() {\n return store.state.x.search?.redirections ?? []\n },\n get relatedTags() {\n return store.getters[getGetterPath('relatedTags', 'relatedTags')] ?? []\n },\n get results() {\n return store.state.x.search?.results ?? []\n },\n get scroll() {\n return store.state.x.scroll?.data ?? {}\n },\n get selectedFilters() {\n return store.getters[getGetterPath('facets', 'selectedFilters')] ?? []\n },\n get selectedRelatedTags() {\n return store.state.x.relatedTags?.selectedRelatedTags ?? []\n },\n get selectedPrompt() {\n return store.state.x.relatedPrompts?.selectedPrompt ?? -1\n },\n get semanticQueries() {\n return store.state.x.semanticQueries?.semanticQueries ?? []\n },\n get relatedPrompts() {\n return store.state.x.relatedPrompts?.relatedPrompts ?? []\n },\n get spellcheckedQuery() {\n return store.state.x.search?.spellcheckedQuery ?? null\n },\n get totalResults() {\n return store.state.x.search?.totalResults ?? 0\n },\n get browseTotalResults() {\n return store.state.x.browse?.totalResults ?? 0\n },\n get selectedSort() {\n return store.state.x.search?.sort ?? ''\n },\n get priceStats() {\n return store.state.x.search?.stats?.price ?? {}\n },\n }\n}\n\n/**\n * Alias to facilitate retrieving values from the store.\n *\n * @public\n */\nexport interface UseAliasAPI {\n /** The {@link DeviceXModule} detected device. */\n readonly device: string | null\n /** The {@link FacetsXModule} facets. */\n readonly facets: Record<Facet['id'], Facet>\n /** The {@link HistoryQueriesXModule} history queries matching the query. */\n readonly historyQueries: ReadonlyArray<HistoryQuery>\n /** The {@link HistoryQueriesXModule} history queries with 1 or more results. */\n readonly historyQueriesWithResults: ReadonlyArray<HistoryQuery>\n /** The {@link HistoryQueriesXModule} history queries. */\n readonly fullHistoryQueries: ReadonlyArray<HistoryQuery>\n /** The {@link HistoryQueriesXModule} history queries enabled flag. */\n readonly isHistoryQueriesEnabled: Readonly<boolean>\n /** The {@link SearchXModule} no results with filters flag. */\n readonly fromNoResultsWithFilters: Readonly<boolean>\n /** The {@link IdentifierResultsXModule} results. */\n readonly identifierResults: ReadonlyArray<Result>\n /** The {@link SearchBoxXModule } input status. */\n readonly searchBoxStatus: InputStatus | undefined\n /** The {@link Empathize} is open state. */\n readonly isEmpathizeOpen: boolean\n /** The {@link NextQueriesXModule} next queries. */\n readonly nextQueries: ReadonlyArray<NextQuery>\n /** The {@link SearchXModule} no results situation. */\n readonly noResults: boolean\n /** The {@link SearchXModule} low results situation. */\n readonly lowResults: boolean\n /** The {@link SearchXModule} partial results. */\n readonly partialResults: ReadonlyArray<PartialResult>\n /** The {@link PopularSearchesXModule} popular searches. */\n readonly popularSearches: ReadonlyArray<Suggestion>\n /** The query value of the different modules. */\n readonly query: UseAliasQueryAPI\n /** The {@link QuerySuggestionsXModule} query suggestions that should be displayed. */\n readonly querySuggestions: ReadonlyArray<Suggestion>\n /** The {@link QuerySuggestionsXModule} query suggestions. */\n readonly fullQuerySuggestions: ReadonlyArray<Suggestion>\n /** The {@link RecommendationsXModule} recommendations. */\n readonly recommendations: ReadonlyArray<Result>\n /** The {@link SearchXModule} redirections. */\n readonly redirections: ReadonlyArray<Redirection>\n /** The {@link RelatedTagsXModule} related tags (Both selected and deselected). */\n readonly relatedTags: ReadonlyArray<RelatedTag>\n /** The {@link SearchXModule} search results. */\n readonly results: ReadonlyArray<Result>\n /** The {@link ScrollXModule} data state. */\n readonly scroll: Record<string, ScrollComponentState>\n /** The {@link FacetsXModule} selected filters. */\n readonly selectedFilters: Filter[]\n /** The {@link RelatedTagsXModule} selected related tags. */\n readonly selectedRelatedTags: ReadonlyArray<RelatedTag>\n /** The {@link RelatedPromptsXModule} selected prompt. */\n readonly selectedPrompt: number\n /** The {@link SemanticQueriesXModule} queries. */\n readonly semanticQueries: ReadonlyArray<SemanticQuery>\n /** The {@link RelatedPromptsXModule} related prompts. */\n readonly relatedPrompts: ReadonlyArray<RelatedPrompt>\n /** The {@link SearchXModule} spellchecked query. */\n readonly spellcheckedQuery: string | null\n /** The status value of the different modules. */\n readonly status: UseAliasStatusAPI\n /** The {@link SearchXModule} total results. */\n readonly totalResults: number\n /** The {@link BrowseXModule} total results. */\n readonly browseTotalResults: number\n /** The {@link SearchXModule} selected sort. */\n readonly selectedSort: string\n /** The {@link SearchXModule} price specific stats. */\n readonly priceStats: { min: number; max: number }\n}\n\n/**\n * Alias to facilitate retrieving the modules with query.\n *\n * @public\n */\nexport interface UseAliasQueryAPI {\n /** The {@link FacetsXModule} query. */\n readonly facets: string\n /** The {@link SearchBoxXModule} query. */\n readonly searchBox: string\n /** The {@link NextQueriesXModule} query. */\n readonly nextQueries: string\n /** The {@link QuerySuggestionsXModule} query. */\n readonly querySuggestions: string\n /** The {@link RelatedTagsXModule} query. */\n readonly relatedTags: string\n /** The {@link SearchXModule} query. */\n readonly search: string\n}\n\n/**\n * Alias to facilitate retrieving the modules with status.\n *\n * @public\n */\nexport interface UseAliasStatusAPI {\n /** The {@link IdentifierResultsXModule} status. */\n readonly identifierResults: RequestStatus | undefined\n /** The {@link NextQueriesXModule} status. */\n readonly nextQueries: RequestStatus | undefined\n /** The {@link PopularSearchesXModule} status. */\n readonly popularSearches: RequestStatus | undefined\n /** The {@link QuerySuggestionsXModule} status. */\n readonly querySuggestions: RequestStatus | undefined\n /** The {@link RecommendationsXModule} status. */\n readonly recommendations: RequestStatus | undefined\n /** The {@link RelatedTagsXModule} status. */\n readonly relatedTags: RequestStatus | undefined\n /** The {@link SearchXModule} status. */\n readonly search: RequestStatus | undefined\n}\n\n/* eslint-enable ts/no-unsafe-return,ts/no-unsafe-member-access,ts/no-unsafe-assignment */\n"],"names":[],"mappings":";;;;;;AAmBA;AAEA;;;;;;AAMG;SACa,WAAW,GAAA;AACzB,IAAA,MAAM,YAAY,GAAG;QACnB,QAAQ;QACR,WAAW;QACX,aAAa;QACb,kBAAkB;QAClB,aAAa;QACb,QAAQ;KACA;AACV,IAAA,MAAM,aAAa,GAAG;QACpB,mBAAmB;QACnB,aAAa;QACb,iBAAiB;QACjB,kBAAkB;QAClB,iBAAiB;QACjB,aAAa;QACb,QAAQ;KACA;AAEV,IAAA,MAAM,KAAK,GAAG,QAAQ,EAAE;IAExB,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,KAAI;AACpD,QAAA,OAAO,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE;YAC5C,GAAG,GAAA;AACD,gBAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,IAAI,EAAE;YAC/C,CAAC;AACD,YAAA,UAAU,EAAE,IAAI;AACjB,SAAA,CAAC;IACJ,CAAC,EAAE,EAAsB,CAAC;IAE1B,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,KAAI;AACtD,QAAA,OAAO,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE;YAC5C,GAAG,GAAA;gBACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM;YAC1C,CAAC;AACD,YAAA,UAAU,EAAE,IAAI;AACjB,SAAA,CAAC;IACJ,CAAC,EAAE,EAAuB,CAAC;IAE3B,OAAO;QACL,KAAK;QACL,MAAM;AACN,QAAA,IAAI,MAAM,GAAA;YACR,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI;QAC3C,CAAC;AACD,QAAA,IAAI,MAAM,GAAA;AACR,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE;QAC/D,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;AAChB,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,IAAI,EAAE;QAC/E,CAAC;AACD,QAAA,IAAI,yBAAyB,GAAA;AAC3B,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAE,2BAA2B,CAAC,CAAC,IAAI,EAAE;QAC1F,CAAC;AACD,QAAA,IAAI,kBAAkB,GAAA;YACpB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,cAAc,IAAI,EAAE;QAC3D,CAAC;AACD,QAAA,IAAI,uBAAuB,GAAA;YACzB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,SAAS,IAAI,KAAK;QACzD,CAAC;AACD,QAAA,IAAI,wBAAwB,GAAA;YAC1B,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,wBAAwB,IAAI,KAAK;QAChE,CAAC;AACD,QAAA,IAAI,iBAAiB,GAAA;YACnB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,iBAAiB,EAAE,iBAAiB,IAAI,EAAE;QACjE,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,WAAW,IAAI,SAAS;QAC1D,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,IAAI,KAAK;QACjD,CAAC;AACD,QAAA,IAAI,WAAW,GAAA;AACb,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,IAAI,EAAE;QACzE,CAAC;AACD,QAAA,IAAI,SAAS,GAAA;YACX,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,IAAI,KAAK;QACnD,CAAC;AACD,QAAA,IAAI,UAAU,GAAA;YACZ,QACE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,GAAG,CAAC;gBACtC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS;QAEhF,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;YAChB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,cAAc,IAAI,EAAE;QACnD,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,EAAE,eAAe,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,gBAAgB,GAAA;AAClB,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,IAAI,EAAE;QACnF,CAAC;AACD,QAAA,IAAI,oBAAoB,GAAA;YACtB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,gBAAgB,EAAE,WAAW,IAAI,EAAE;QAC1D,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,EAAE,eAAe,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,IAAI,EAAE;QACjD,CAAC;AACD,QAAA,IAAI,WAAW,GAAA;AACb,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,IAAI,EAAE;QACzE,CAAC;AACD,QAAA,IAAI,OAAO,GAAA;YACT,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE;QAC5C,CAAC;AACD,QAAA,IAAI,MAAM,GAAA;YACR,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE;QACzC,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;AACjB,YAAA,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,IAAI,EAAE;QACxE,CAAC;AACD,QAAA,IAAI,mBAAmB,GAAA;YACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,mBAAmB,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;AAChB,YAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,cAAc,IAAI,EAAE;QAC3D,CAAC;AACD,QAAA,IAAI,eAAe,GAAA;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,EAAE,eAAe,IAAI,EAAE;QAC7D,CAAC;AACD,QAAA,IAAI,cAAc,GAAA;YAChB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,EAAE,cAAc,IAAI,EAAE;QAC3D,CAAC;AACD,QAAA,IAAI,iBAAiB,GAAA;YACnB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,iBAAiB,IAAI,IAAI;QACxD,CAAC;AACD,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,IAAI,CAAC;QAChD,CAAC;AACD,QAAA,IAAI,kBAAkB,GAAA;YACpB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,IAAI,CAAC;QAChD,CAAC;AACD,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE;QACzC,CAAC;AACD,QAAA,IAAI,UAAU,GAAA;AACZ,YAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE;QACjD,CAAC;KACF;AACH;AAwHA;;;;"}
package/js/index.js CHANGED
@@ -442,6 +442,6 @@ export { taggingXModule } from './x-modules/tagging/x-module.js';
442
442
  export { default as UrlHandler } from './x-modules/url/components/url-handler.vue.js';
443
443
  export { replaceableParams, urlEmitters } from './x-modules/url/store/emitters.js';
444
444
  export { urlXStoreModule } from './x-modules/url/store/module.js';
445
- export { setInitialExtraParams, setParams, setUrlFilters, setUrlPage, setUrlParamsFromPreview, setUrlPrompt, setUrlQuery, setUrlQueryFromPreview, setUrlRelatedTags, setUrlScroll, setUrlSelectedFiltersFromPreview, setUrlSort, urlWiring } from './x-modules/url/wiring.js';
445
+ export { resetUrlBrowseCategory, setInitialExtraParams, setParams, setUrlBrowseCategory, setUrlFilters, setUrlPage, setUrlParamsFromPreview, setUrlPrompt, setUrlQuery, setUrlQueryFromPreview, setUrlRelatedTags, setUrlScroll, setUrlSelectedFiltersFromPreview, setUrlSort, urlWiring } from './x-modules/url/wiring.js';
446
446
  export { urlXModule } from './x-modules/url/x-module.js';
447
447
  //# sourceMappingURL=index.js.map
@@ -81,6 +81,18 @@ class BaseXAPI {
81
81
  }
82
82
  void this.bus?.emit('UserClickedOpenX', undefined);
83
83
  }
84
+ /**
85
+ * Browses the browseField and browseValue parameters as a selected category.
86
+ *
87
+ * @param browseCategory - browseField and browseValue to be browsed.
88
+ *
89
+ * @public
90
+ */
91
+ browse(browseCategory) {
92
+ if (browseCategory) {
93
+ void this.bus?.emit('UserBrowsedToCategory', browseCategory);
94
+ }
95
+ }
84
96
  /**
85
97
  * Initializes the Application passing the {@link SnippetConfig}.
86
98
  *