@empathyco/x-components 8.8.1 → 8.10.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.
- package/CHANGELOG.md +14 -0
- package/docs/API-reference/api/x-components.hierarchicalfilter.md +3 -0
- package/docs/API-reference/api/x-components.simplefilter.md +3 -0
- package/docs/API-reference/api/x-components.snippetcallbacks.md +3 -0
- package/docs/API-reference/api/x-components.vendoractions.md +43 -0
- package/docs/API-reference/api/x-components.vendoractions.seturlparams.md +11 -0
- package/docs/API-reference/api/x-components.vendorbannertagging.md +17 -0
- package/docs/API-reference/api/x-components.vendorbannertagging.mountedurl.md +11 -0
- package/docs/API-reference/api/x-components.vendorgetters.md +43 -0
- package/docs/API-reference/api/x-components.vendorgetters.query.md +11 -0
- package/docs/API-reference/api/x-components.vendormutations.md +36 -1
- package/docs/API-reference/api/x-components.vendormutations.resetstate.md +11 -0
- package/docs/API-reference/api/x-components.vendormutations.setrelatedtags.md +11 -0
- package/docs/API-reference/api/x-components.vendorresulttagging.md +17 -0
- package/docs/API-reference/api/x-components.vendorresulttagging.mountedurl.md +11 -0
- package/docs/API-reference/api/x-components.vendorstate.md +19 -1
- package/docs/API-reference/api/x-components.vendorstate.relatedtags.md +11 -0
- package/docs/API-reference/api/x-components.vendorxevents.md +57 -0
- package/docs/API-reference/api/x-components.vendorxevents.vendorbannermounted.md +13 -0
- package/docs/API-reference/api/x-components.vendorxevents.vendorquerychanged.md +13 -0
- package/docs/API-reference/api/x-components.vendorxevents.vendorresultmounted.md +13 -0
- package/js/index.js +1 -1
- package/js/x-modules/vendor/store/actions/set-url-params.action.js +6 -0
- package/js/x-modules/vendor/store/actions/set-url-params.action.js.map +1 -0
- package/js/x-modules/vendor/store/emitters.js +3 -1
- package/js/x-modules/vendor/store/emitters.js.map +1 -1
- package/js/x-modules/vendor/store/getters/query.getter.js +8 -0
- package/js/x-modules/vendor/store/getters/query.getter.js.map +1 -0
- package/js/x-modules/vendor/store/module.js +34 -5
- package/js/x-modules/vendor/store/module.js.map +1 -1
- package/js/x-modules/vendor/wiring.js +66 -16
- package/js/x-modules/vendor/wiring.js.map +1 -1
- package/package.json +2 -2
- package/report/x-components.api.json +421 -15
- package/report/x-components.api.md +66 -10
- package/types/src/components/snippet-callbacks.vue.d.ts +3 -0
- package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +3 -0
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts +3 -0
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/vendor/events.types.d.ts +15 -0
- package/types/src/x-modules/vendor/events.types.d.ts.map +1 -1
- package/types/src/x-modules/vendor/store/actions/set-url-params.action.d.ts +3 -0
- package/types/src/x-modules/vendor/store/actions/set-url-params.action.d.ts.map +1 -0
- package/types/src/x-modules/vendor/store/emitters.d.ts +3 -1
- package/types/src/x-modules/vendor/store/emitters.d.ts.map +1 -1
- package/types/src/x-modules/vendor/store/getters/index.d.ts +2 -0
- package/types/src/x-modules/vendor/store/getters/index.d.ts.map +1 -0
- package/types/src/x-modules/vendor/store/getters/query.getter.d.ts +3 -0
- package/types/src/x-modules/vendor/store/getters/query.getter.d.ts.map +1 -0
- package/types/src/x-modules/vendor/store/module.d.ts +12 -0
- package/types/src/x-modules/vendor/store/module.d.ts.map +1 -1
- package/types/src/x-modules/vendor/store/types.d.ts +10 -2
- package/types/src/x-modules/vendor/store/types.d.ts.map +1 -1
- package/types/src/x-modules/vendor/types.d.ts +2 -0
- package/types/src/x-modules/vendor/types.d.ts.map +1 -1
- package/types/src/x-modules/vendor/wiring.d.ts +28 -7
- package/types/src/x-modules/vendor/wiring.d.ts.map +1 -1
- package/vendor/index.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,20 @@
|
|
|
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
|
+
## [8.10.0](https://github.com/empathyco/x/compare/@empathyco/x-components@8.9.0...@empathyco/x-components@8.10.0) (2026-07-30)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* **vendor:** add mounted event tracking for vendor banners and results (#2146)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## [8.9.0](https://github.com/empathyco/x/compare/@empathyco/x-components@8.8.1...@empathyco/x-components@8.9.0) (2026-07-29)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **vendor:** enhance state management with query reset functionality (#2145)
|
|
18
|
+
|
|
19
|
+
|
|
6
20
|
## [8.8.1](https://github.com/empathyco/x/compare/@empathyco/x-components@8.8.0...@empathyco/x-components@8.8.1) (2026-07-21)
|
|
7
21
|
|
|
8
22
|
### Bug Fixes
|
|
@@ -211,12 +211,15 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
211
211
|
UserClickedAnAiCarouselAdd2Cart?: import("@empathyco/x-types").Result | undefined;
|
|
212
212
|
AiComponentMounted?: void | undefined;
|
|
213
213
|
VendorResultsChanged?: Omit<import("../../../vendor").VendorResult, "modelName">[] | undefined;
|
|
214
|
+
VendorResultMounted?: import("../../../vendor").VendorResult | undefined;
|
|
214
215
|
UserViewedAVendorResult?: import("../../../vendor").VendorResult | undefined;
|
|
215
216
|
UserClickedAVendorResult?: import("../../../vendor").VendorResult | undefined;
|
|
216
217
|
UserClickedVendorResultAddToCart?: import("../../../vendor").VendorResult | undefined;
|
|
217
218
|
VendorBannersChanged?: Omit<import("../../../vendor").VendorBanner, "modelName">[] | undefined;
|
|
219
|
+
VendorBannerMounted?: import("../../../vendor").VendorBanner | undefined;
|
|
218
220
|
UserViewedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
219
221
|
UserClickedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
222
|
+
VendorQueryChanged?: string | undefined;
|
|
220
223
|
}>;
|
|
221
224
|
innerCssClasses: import("vue").ComputedRef<(string | Dictionary<boolean>)[]>;
|
|
222
225
|
renderedChildrenFilters: import("vue").ComputedRef<HierarchicalFilterModel[]>;
|
|
@@ -208,12 +208,15 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
208
208
|
UserClickedAnAiCarouselAdd2Cart?: import("@empathyco/x-types").Result | undefined;
|
|
209
209
|
AiComponentMounted?: void | undefined;
|
|
210
210
|
VendorResultsChanged?: Omit<import("../../../vendor").VendorResult, "modelName">[] | undefined;
|
|
211
|
+
VendorResultMounted?: import("../../../vendor").VendorResult | undefined;
|
|
211
212
|
UserViewedAVendorResult?: import("../../../vendor").VendorResult | undefined;
|
|
212
213
|
UserClickedAVendorResult?: import("../../../vendor").VendorResult | undefined;
|
|
213
214
|
UserClickedVendorResultAddToCart?: import("../../../vendor").VendorResult | undefined;
|
|
214
215
|
VendorBannersChanged?: Omit<import("../../../vendor").VendorBanner, "modelName">[] | undefined;
|
|
216
|
+
VendorBannerMounted?: import("../../../vendor").VendorBanner | undefined;
|
|
215
217
|
UserViewedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
216
218
|
UserClickedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
219
|
+
VendorQueryChanged?: string | undefined;
|
|
217
220
|
}>;
|
|
218
221
|
innerCssClasses: import("vue").ComputedRef<(string | Dictionary<boolean>)[]>;
|
|
219
222
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -198,12 +198,15 @@ _default: import("vue").DefineComponent<{}, {
|
|
|
198
198
|
UserClickedAnAiCarouselAdd2Cart: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
|
|
199
199
|
AiComponentMounted: (payload: undefined, metadata: WireMetadata) => unknown;
|
|
200
200
|
VendorResultsChanged: (payload: Omit<import("..").VendorResult, "modelName">[], metadata: WireMetadata) => unknown;
|
|
201
|
+
VendorResultMounted: (payload: import("..").VendorResult, metadata: WireMetadata) => unknown;
|
|
201
202
|
UserViewedAVendorResult: (payload: import("..").VendorResult, metadata: WireMetadata) => unknown;
|
|
202
203
|
UserClickedAVendorResult: (payload: import("..").VendorResult, metadata: WireMetadata) => unknown;
|
|
203
204
|
UserClickedVendorResultAddToCart: (payload: import("..").VendorResult, metadata: WireMetadata) => unknown;
|
|
204
205
|
VendorBannersChanged: (payload: Omit<import("..").VendorBanner, "modelName">[], metadata: WireMetadata) => unknown;
|
|
206
|
+
VendorBannerMounted: (payload: import("..").VendorBanner, metadata: WireMetadata) => unknown;
|
|
205
207
|
UserViewedAVendorBanner: (payload: import("..").VendorBanner, metadata: WireMetadata) => unknown;
|
|
206
208
|
UserClickedAVendorBanner: (payload: import("..").VendorBanner, metadata: WireMetadata) => unknown;
|
|
209
|
+
VendorQueryChanged: (payload: string, metadata: WireMetadata) => unknown;
|
|
207
210
|
}>>;
|
|
208
211
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {
|
|
209
212
|
GlobalXBus: import("vue").DefineComponent<{}, {}, any>;
|
|
@@ -9,3 +9,46 @@
|
|
|
9
9
|
```typescript
|
|
10
10
|
export interface VendorActions
|
|
11
11
|
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
<table><thead><tr><th>
|
|
16
|
+
|
|
17
|
+
Property
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
</th><th>
|
|
21
|
+
|
|
22
|
+
Modifiers
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</th><th>
|
|
26
|
+
|
|
27
|
+
Type
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
</th><th>
|
|
31
|
+
|
|
32
|
+
Description
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
</th></tr></thead>
|
|
36
|
+
<tbody><tr><td>
|
|
37
|
+
|
|
38
|
+
[setUrlParams](./x-components.vendoractions.seturlparams.md)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
</td><td>
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
</td><td>
|
|
45
|
+
|
|
46
|
+
(urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) => void
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</td><td>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td></tr>
|
|
53
|
+
</tbody></table>
|
|
54
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorActions](./x-components.vendoractions.md) > [setUrlParams](./x-components.vendoractions.seturlparams.md)
|
|
4
|
+
|
|
5
|
+
## VendorActions.setUrlParams property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
setUrlParams: (urlParams: UrlParams) => void;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorBannerTagging](./x-components.vendorbannertagging.md) > [mountedUrl](./x-components.vendorbannertagging.mountedurl.md)
|
|
4
|
+
|
|
5
|
+
## VendorBannerTagging.mountedUrl property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
mountedUrl: string;
|
|
11
|
+
```
|
|
@@ -9,3 +9,46 @@
|
|
|
9
9
|
```typescript
|
|
10
10
|
export interface VendorGetters
|
|
11
11
|
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
<table><thead><tr><th>
|
|
16
|
+
|
|
17
|
+
Property
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
</th><th>
|
|
21
|
+
|
|
22
|
+
Modifiers
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</th><th>
|
|
26
|
+
|
|
27
|
+
Type
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
</th><th>
|
|
31
|
+
|
|
32
|
+
Description
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
</th></tr></thead>
|
|
36
|
+
<tbody><tr><td>
|
|
37
|
+
|
|
38
|
+
[query](./x-components.vendorgetters.query.md)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
</td><td>
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
</td><td>
|
|
45
|
+
|
|
46
|
+
string
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</td><td>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td></tr>
|
|
53
|
+
</tbody></table>
|
|
54
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorGetters](./x-components.vendorgetters.md) > [query](./x-components.vendorgetters.query.md)
|
|
4
|
+
|
|
5
|
+
## VendorGetters.query property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
query: string;
|
|
11
|
+
```
|
|
@@ -7,8 +7,9 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
export interface VendorMutations
|
|
10
|
+
export interface VendorMutations extends QueryMutations
|
|
11
11
|
```
|
|
12
|
+
**Extends:** [QueryMutations](./x-components.querymutations.md)
|
|
12
13
|
|
|
13
14
|
## Properties
|
|
14
15
|
|
|
@@ -35,6 +36,23 @@ Description
|
|
|
35
36
|
</th></tr></thead>
|
|
36
37
|
<tbody><tr><td>
|
|
37
38
|
|
|
39
|
+
[resetState](./x-components.vendormutations.resetstate.md)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
</td><td>
|
|
46
|
+
|
|
47
|
+
() => void
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
</td><td>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</td></tr>
|
|
54
|
+
<tr><td>
|
|
55
|
+
|
|
38
56
|
[setBanners](./x-components.vendormutations.setbanners.md)
|
|
39
57
|
|
|
40
58
|
|
|
@@ -49,6 +67,23 @@ Description
|
|
|
49
67
|
</td><td>
|
|
50
68
|
|
|
51
69
|
|
|
70
|
+
</td></tr>
|
|
71
|
+
<tr><td>
|
|
72
|
+
|
|
73
|
+
[setRelatedTags](./x-components.vendormutations.setrelatedtags.md)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
</td><td>
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
</td><td>
|
|
80
|
+
|
|
81
|
+
(relatedTags: RelatedTag\[\]) => void
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
</td><td>
|
|
85
|
+
|
|
86
|
+
|
|
52
87
|
</td></tr>
|
|
53
88
|
<tr><td>
|
|
54
89
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorMutations](./x-components.vendormutations.md) > [resetState](./x-components.vendormutations.resetstate.md)
|
|
4
|
+
|
|
5
|
+
## VendorMutations.resetState property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
resetState: () => void;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorMutations](./x-components.vendormutations.md) > [setRelatedTags](./x-components.vendormutations.setrelatedtags.md)
|
|
4
|
+
|
|
5
|
+
## VendorMutations.setRelatedTags property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
setRelatedTags: (relatedTags: RelatedTag[]) => void;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorResultTagging](./x-components.vendorresulttagging.md) > [mountedUrl](./x-components.vendorresulttagging.mountedurl.md)
|
|
4
|
+
|
|
5
|
+
## VendorResultTagging.mountedUrl property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
mountedUrl: string;
|
|
11
|
+
```
|
|
@@ -7,8 +7,9 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
export interface VendorState
|
|
10
|
+
export interface VendorState extends QueryState
|
|
11
11
|
```
|
|
12
|
+
**Extends:** [QueryState](./x-components.querystate.md)
|
|
12
13
|
|
|
13
14
|
## Properties
|
|
14
15
|
|
|
@@ -49,6 +50,23 @@ Description
|
|
|
49
50
|
</td><td>
|
|
50
51
|
|
|
51
52
|
|
|
53
|
+
</td></tr>
|
|
54
|
+
<tr><td>
|
|
55
|
+
|
|
56
|
+
[relatedTags](./x-components.vendorstate.relatedtags.md)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
</td><td>
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td><td>
|
|
63
|
+
|
|
64
|
+
RelatedTag\[\]
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
</td><td>
|
|
68
|
+
|
|
69
|
+
|
|
52
70
|
</td></tr>
|
|
53
71
|
<tr><td>
|
|
54
72
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorState](./x-components.vendorstate.md) > [relatedTags](./x-components.vendorstate.relatedtags.md)
|
|
4
|
+
|
|
5
|
+
## VendorState.relatedTags property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
relatedTags: RelatedTag[];
|
|
11
|
+
```
|
|
@@ -129,6 +129,25 @@ The user viewed a vendor banner. Payload: The [vendor banner](./x-components.ven
|
|
|
129
129
|
The user viewed a vendor result. Payload: The [vendor result](./x-components.vendorresult.md) that was viewed.
|
|
130
130
|
|
|
131
131
|
|
|
132
|
+
</td></tr>
|
|
133
|
+
<tr><td>
|
|
134
|
+
|
|
135
|
+
[VendorBannerMounted](./x-components.vendorxevents.vendorbannermounted.md)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
</td><td>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</td><td>
|
|
142
|
+
|
|
143
|
+
[VendorBanner](./x-components.vendorbanner.md)
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</td><td>
|
|
147
|
+
|
|
148
|
+
A vendor banner has been inserted in the DOM. Payload: The [vendor banner](./x-components.vendorbanner.md) that was mounted.
|
|
149
|
+
|
|
150
|
+
|
|
132
151
|
</td></tr>
|
|
133
152
|
<tr><td>
|
|
134
153
|
|
|
@@ -148,6 +167,44 @@ Omit<[VendorBanner](./x-components.vendorbanner.md)<!-- -->, 'modelName'>\
|
|
|
148
167
|
The x consumer has provided vendor banners to be inserted in the result grid. Payload: The array of vendor banner inputs with their items and positions. modelName is excluded since it is an internal field, and we will assign it under the hood.
|
|
149
168
|
|
|
150
169
|
|
|
170
|
+
</td></tr>
|
|
171
|
+
<tr><td>
|
|
172
|
+
|
|
173
|
+
[VendorQueryChanged](./x-components.vendorxevents.vendorquerychanged.md)
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
</td><td>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
</td><td>
|
|
180
|
+
|
|
181
|
+
string
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</td><td>
|
|
185
|
+
|
|
186
|
+
The vendor module query has changed. Payload: The new vendor query string.
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
</td></tr>
|
|
190
|
+
<tr><td>
|
|
191
|
+
|
|
192
|
+
[VendorResultMounted](./x-components.vendorxevents.vendorresultmounted.md)
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
</td><td>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</td><td>
|
|
199
|
+
|
|
200
|
+
[VendorResult](./x-components.vendorresult.md)
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</td><td>
|
|
204
|
+
|
|
205
|
+
A vendor result has been inserted in the DOM. Payload: The [vendor result](./x-components.vendorresult.md) that was mounted.
|
|
206
|
+
|
|
207
|
+
|
|
151
208
|
</td></tr>
|
|
152
209
|
<tr><td>
|
|
153
210
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorXEvents](./x-components.vendorxevents.md) > [VendorBannerMounted](./x-components.vendorxevents.vendorbannermounted.md)
|
|
4
|
+
|
|
5
|
+
## VendorXEvents.VendorBannerMounted property
|
|
6
|
+
|
|
7
|
+
A vendor banner has been inserted in the DOM. Payload: The [vendor banner](./x-components.vendorbanner.md) that was mounted.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
VendorBannerMounted: VendorBanner;
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorXEvents](./x-components.vendorxevents.md) > [VendorQueryChanged](./x-components.vendorxevents.vendorquerychanged.md)
|
|
4
|
+
|
|
5
|
+
## VendorXEvents.VendorQueryChanged property
|
|
6
|
+
|
|
7
|
+
The vendor module query has changed. Payload: The new vendor query string.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
VendorQueryChanged: string;
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorXEvents](./x-components.vendorxevents.md) > [VendorResultMounted](./x-components.vendorxevents.vendorresultmounted.md)
|
|
4
|
+
|
|
5
|
+
## VendorXEvents.VendorResultMounted property
|
|
6
|
+
|
|
7
|
+
A vendor result has been inserted in the DOM. Payload: The [vendor result](./x-components.vendorresult.md) that was mounted.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
VendorResultMounted: VendorResult;
|
|
13
|
+
```
|
package/js/index.js
CHANGED
|
@@ -461,7 +461,7 @@ export { urlXModule } from './x-modules/url/x-module.js';
|
|
|
461
461
|
export { default as VendorBannersList } from './x-modules/vendor/components/vendor-banners-list.vue.js';
|
|
462
462
|
export { default as VendorResultsList } from './x-modules/vendor/components/vendor-results-list.vue.js';
|
|
463
463
|
export { vendorEmitters } from './x-modules/vendor/store/emitters.js';
|
|
464
|
-
export { vendorXStoreModule } from './x-modules/vendor/store/module.js';
|
|
464
|
+
export { resettableVendorState, vendorXStoreModule } from './x-modules/vendor/store/module.js';
|
|
465
465
|
export { setBanners, setResults, vendorWiring } from './x-modules/vendor/wiring.js';
|
|
466
466
|
export { vendorXModule } from './x-modules/vendor/x-module.js';
|
|
467
467
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"set-url-params.action.js","sources":["../../../../../../src/x-modules/vendor/store/actions/set-url-params.action.ts"],"sourcesContent":["import type { VendorXStoreModule } from '../types'\n\nexport const setUrlParams: VendorXStoreModule['actions']['setUrlParams'] = (\n { commit },\n { query },\n) => {\n commit('setQuery', query)\n}\n"],"names":[],"mappings":"AAEO,MAAM,YAAY,GAAkD,CACzE,EAAE,MAAM,EAAE,EACV,EAAE,KAAK,EAAE,KACP;AACF,IAAA,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC;AAC3B;;;;"}
|
|
@@ -7,7 +7,9 @@ import { vendorXStoreModule } from './module.js';
|
|
|
7
7
|
*
|
|
8
8
|
* @internal
|
|
9
9
|
*/
|
|
10
|
-
const vendorEmitters = createStoreEmitters(vendorXStoreModule, {
|
|
10
|
+
const vendorEmitters = createStoreEmitters(vendorXStoreModule, {
|
|
11
|
+
VendorQueryChanged: (_, getters) => getters.query,
|
|
12
|
+
});
|
|
11
13
|
|
|
12
14
|
export { vendorEmitters };
|
|
13
15
|
//# sourceMappingURL=emitters.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"emitters.js","sources":["../../../../../src/x-modules/vendor/store/emitters.ts"],"sourcesContent":["import { createStoreEmitters } from '../../../store'\nimport { vendorXStoreModule } from './module'\n\n/**\n * {@link StoreEmitters} For the vendor module.\n *\n * @internal\n */\nexport const vendorEmitters = createStoreEmitters(vendorXStoreModule, {})\n"],"names":[],"mappings":";;;;AAGA;;;;AAIG;AACI,MAAM,cAAc,GAAG,mBAAmB,CAAC,kBAAkB,EAAE,EAAE;;;;"}
|
|
1
|
+
{"version":3,"file":"emitters.js","sources":["../../../../../src/x-modules/vendor/store/emitters.ts"],"sourcesContent":["import { createStoreEmitters } from '../../../store'\nimport { vendorXStoreModule } from './module'\n\n/**\n * {@link StoreEmitters} For the vendor module.\n *\n * @internal\n */\nexport const vendorEmitters = createStoreEmitters(vendorXStoreModule, {\n VendorQueryChanged: (_, getters) => getters.query,\n})\n"],"names":[],"mappings":";;;;AAGA;;;;AAIG;AACI,MAAM,cAAc,GAAG,mBAAmB,CAAC,kBAAkB,EAAE;IACpE,kBAAkB,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK;AAClD,CAAA;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query.getter.js","sources":["../../../../../../src/x-modules/vendor/store/getters/query.getter.ts"],"sourcesContent":["import type { VendorXStoreModule } from '../types'\nimport { createRelatedTagsQueryGetter } from '../../../../store/utils/query.utils'\n\nexport const query: VendorXStoreModule['getters']['query'] = createRelatedTagsQueryGetter({\n getRelatedTags: state => state.relatedTags,\n})\n"],"names":[],"mappings":";;AAGO,MAAM,KAAK,GAA2C,4BAA4B,CAAC;AACxF,IAAA,cAAc,EAAE,KAAK,IAAI,KAAK,CAAC,WAAW;AAC3C,CAAA;;;;"}
|
|
@@ -1,19 +1,48 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import { setQuery } from '../../../store/utils/query.utils.js';
|
|
2
|
+
import { setUrlParams } from './actions/set-url-params.action.js';
|
|
3
|
+
import { query } from './getters/query.getter.js';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Function to return the "resettable" part of the state.
|
|
7
|
+
*
|
|
8
|
+
* @returns The "resettable" part of the {@link VendorState}.
|
|
9
|
+
*
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
function resettableVendorState() {
|
|
13
|
+
return {
|
|
3
14
|
banners: [],
|
|
15
|
+
relatedTags: [],
|
|
4
16
|
results: [],
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
const vendorXStoreModule = {
|
|
20
|
+
state: () => ({
|
|
21
|
+
query: '',
|
|
22
|
+
...resettableVendorState(),
|
|
5
23
|
}),
|
|
6
|
-
getters: {
|
|
24
|
+
getters: {
|
|
25
|
+
query,
|
|
26
|
+
},
|
|
7
27
|
mutations: {
|
|
28
|
+
setQuery,
|
|
8
29
|
setBanners(state, banners) {
|
|
9
30
|
state.banners = banners;
|
|
10
31
|
},
|
|
32
|
+
setRelatedTags(state, relatedTags) {
|
|
33
|
+
state.relatedTags = relatedTags;
|
|
34
|
+
},
|
|
11
35
|
setResults(state, results) {
|
|
12
36
|
state.results = results;
|
|
13
37
|
},
|
|
38
|
+
resetState(state) {
|
|
39
|
+
Object.assign(state, resettableVendorState());
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
actions: {
|
|
43
|
+
setUrlParams,
|
|
14
44
|
},
|
|
15
|
-
actions: {},
|
|
16
45
|
};
|
|
17
46
|
|
|
18
|
-
export { vendorXStoreModule };
|
|
47
|
+
export { resettableVendorState, vendorXStoreModule };
|
|
19
48
|
//# sourceMappingURL=module.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/vendor/store/module.ts"],"sourcesContent":["import type { VendorXStoreModule } from './types'\n\nexport const vendorXStoreModule: VendorXStoreModule = {\n state: () => ({\n
|
|
1
|
+
{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/vendor/store/module.ts"],"sourcesContent":["import type { VendorXStoreModule } from './types'\nimport { setQuery } from '../../../store/utils/query.utils'\nimport { setUrlParams } from './actions/set-url-params.action'\nimport { query } from './getters/query.getter'\n\n/**\n * Function to return the \"resettable\" part of the state.\n *\n * @returns The \"resettable\" part of the {@link VendorState}.\n *\n * @internal\n */\nexport function resettableVendorState() {\n return {\n banners: [],\n relatedTags: [],\n results: [],\n }\n}\n\nexport const vendorXStoreModule: VendorXStoreModule = {\n state: () => ({\n query: '',\n ...resettableVendorState(),\n }),\n getters: {\n query,\n },\n mutations: {\n setQuery,\n setBanners(state, banners) {\n state.banners = banners\n },\n setRelatedTags(state, relatedTags) {\n state.relatedTags = relatedTags\n },\n setResults(state, results) {\n state.results = results\n },\n resetState(state) {\n Object.assign(state, resettableVendorState())\n },\n },\n actions: {\n setUrlParams,\n },\n}\n"],"names":[],"mappings":";;;;AAKA;;;;;;AAMG;SACa,qBAAqB,GAAA;IACnC,OAAO;AACL,QAAA,OAAO,EAAE,EAAE;AACX,QAAA,WAAW,EAAE,EAAE;AACf,QAAA,OAAO,EAAE,EAAE;KACZ;AACH;AAEO,MAAM,kBAAkB,GAAuB;AACpD,IAAA,KAAK,EAAE,OAAO;AACZ,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,GAAG,qBAAqB,EAAE;KAC3B,CAAC;AACF,IAAA,OAAO,EAAE;QACP,KAAK;AACN,KAAA;AACD,IAAA,SAAS,EAAE;QACT,QAAQ;QACR,UAAU,CAAC,KAAK,EAAE,OAAO,EAAA;AACvB,YAAA,KAAK,CAAC,OAAO,GAAG,OAAO;QACzB,CAAC;QACD,cAAc,CAAC,KAAK,EAAE,WAAW,EAAA;AAC/B,YAAA,KAAK,CAAC,WAAW,GAAG,WAAW;QACjC,CAAC;QACD,UAAU,CAAC,KAAK,EAAE,OAAO,EAAA;AACvB,YAAA,KAAK,CAAC,OAAO,GAAG,OAAO;QACzB,CAAC;AACD,QAAA,UAAU,CAAC,KAAK,EAAA;YACd,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,qBAAqB,EAAE,CAAC;QAC/C,CAAC;AACF,KAAA;AACD,IAAA,OAAO,EAAE;QACP,YAAY;AACb,KAAA;;;;;"}
|