@empathyco/x-components 8.5.0 → 8.7.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 (48) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/API-reference/api/x-components.banner.md +11 -1
  3. package/docs/API-reference/api/x-components.hierarchicalfilter.md +2 -0
  4. package/docs/API-reference/api/x-components.md +11 -0
  5. package/docs/API-reference/api/x-components.simplefilter.md +2 -0
  6. package/docs/API-reference/api/x-components.snippetcallbacks.md +2 -0
  7. package/docs/API-reference/api/x-components.vendorbanner.md +21 -2
  8. package/docs/API-reference/api/x-components.vendorbanner.tagging.md +11 -0
  9. package/docs/API-reference/api/x-components.vendorbannertagging.clickurl.md +11 -0
  10. package/docs/API-reference/api/x-components.vendorbannertagging.md +73 -0
  11. package/docs/API-reference/api/x-components.vendorbannertagging.viewurl.md +11 -0
  12. package/docs/API-reference/api/x-components.vendorxevents.md +38 -0
  13. package/docs/API-reference/api/x-components.vendorxevents.userclickedavendorbanner.md +13 -0
  14. package/docs/API-reference/api/x-components.vendorxevents.userviewedavendorbanner.md +13 -0
  15. package/docs/API-reference/api/x-types.banner.md +2 -2
  16. package/docs/API-reference/components/search/x-components.banner.md +8 -6
  17. package/js/x-modules/facets/wiring.js +1 -0
  18. package/js/x-modules/facets/wiring.js.map +1 -1
  19. package/js/x-modules/search/components/banner.vue.js.map +1 -1
  20. package/js/x-modules/search/components/banner.vue2.js +10 -1
  21. package/js/x-modules/search/components/banner.vue2.js.map +1 -1
  22. package/js/x-modules/search-box/wiring.js +1 -0
  23. package/js/x-modules/search-box/wiring.js.map +1 -1
  24. package/js/x-modules/vendor/wiring.js +8 -0
  25. package/js/x-modules/vendor/wiring.js.map +1 -1
  26. package/package.json +4 -4
  27. package/report/x-components.api.json +283 -10
  28. package/report/x-components.api.md +39 -3
  29. package/report/x-types.api.json +1 -1
  30. package/types/src/components/snippet-callbacks.vue.d.ts +2 -0
  31. package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
  32. package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +2 -0
  33. package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
  34. package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts +2 -0
  35. package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
  36. package/types/src/x-modules/facets/wiring.d.ts +1 -0
  37. package/types/src/x-modules/facets/wiring.d.ts.map +1 -1
  38. package/types/src/x-modules/related-prompts/components/related-prompts-tag-list.vue.d.ts.map +1 -1
  39. package/types/src/x-modules/search/components/banner.vue.d.ts +22 -1
  40. package/types/src/x-modules/search/components/banner.vue.d.ts.map +1 -1
  41. package/types/src/x-modules/search-box/wiring.d.ts +1 -0
  42. package/types/src/x-modules/search-box/wiring.d.ts.map +1 -1
  43. package/types/src/x-modules/vendor/events.types.d.ts +10 -0
  44. package/types/src/x-modules/vendor/events.types.d.ts.map +1 -1
  45. package/types/src/x-modules/vendor/types.d.ts +11 -1
  46. package/types/src/x-modules/vendor/types.d.ts.map +1 -1
  47. package/types/src/x-modules/vendor/wiring.d.ts +6 -0
  48. package/types/src/x-modules/vendor/wiring.d.ts.map +1 -1
@@ -34,6 +34,7 @@ export declare const searchBoxWiring: {
34
34
  transitionState: AnyWire;
35
35
  };
36
36
  UserBrowsedToCategory: {
37
+ clearSearchBoxQuery: AnyWire;
37
38
  transitionState: AnyWire;
38
39
  };
39
40
  UserFocusedSearchBox: {
@@ -1 +1 @@
1
- {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search-box/wiring.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAiExD;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyC1B,CAAA"}
1
+ {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search-box/wiring.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAiExD;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0C1B,CAAA"}
@@ -32,5 +32,15 @@ export interface VendorXEvents {
32
32
  * modelName is excluded since it is an internal field, and we will assign it under the hood.
33
33
  */
34
34
  VendorBannersChanged: Omit<VendorBanner, 'modelName'>[];
35
+ /**
36
+ * The user viewed a vendor banner.
37
+ * Payload: The {@link VendorBanner | vendor banner} that was viewed.
38
+ */
39
+ UserViewedAVendorBanner: VendorBanner;
40
+ /**
41
+ * The user clicked on a vendor banner.
42
+ * Payload: The {@link VendorBanner | vendor banner} that was clicked.
43
+ */
44
+ UserClickedAVendorBanner: VendorBanner;
35
45
  }
36
46
  //# sourceMappingURL=events.types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/vendor/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAA;IACvD;;;OAGG;IACH,uBAAuB,EAAE,YAAY,CAAA;IACrC;;;OAGG;IACH,wBAAwB,EAAE,YAAY,CAAA;IACtC;;;OAGG;IACH,gCAAgC,EAAE,YAAY,CAAA;IAE9C;;;;OAIG;IACH,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAA;CACxD"}
1
+ {"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/vendor/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAA;IACvD;;;OAGG;IACH,uBAAuB,EAAE,YAAY,CAAA;IACrC;;;OAGG;IACH,wBAAwB,EAAE,YAAY,CAAA;IACtC;;;OAGG;IACH,gCAAgC,EAAE,YAAY,CAAA;IAE9C;;;;OAIG;IACH,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAA;IAEvD;;;OAGG;IACH,uBAAuB,EAAE,YAAY,CAAA;IACrC;;;OAGG;IACH,wBAAwB,EAAE,YAAY,CAAA;CACvC"}
@@ -4,6 +4,15 @@ export interface VendorResultTagging {
4
4
  clickUrl: string;
5
5
  add2cartUrl: string;
6
6
  }
7
+ /**
8
+ * The tagging info for a vendor banner.
9
+ *
10
+ * @public
11
+ */
12
+ export interface VendorBannerTagging {
13
+ clickUrl: string;
14
+ viewUrl: string;
15
+ }
7
16
  /**
8
17
  * The interface for a vendor result, extending the base Result interface.
9
18
  */
@@ -17,7 +26,8 @@ export interface VendorResult extends Omit<Result, 'modelName' | 'tagging'>, Nam
17
26
  * - If the position is defined, the banner will be displayed in that position inside the grid.
18
27
  * - If the position is undefined, the banner will be displayed on top of the grid and full width.
19
28
  */
20
- export interface VendorBanner extends Omit<Banner, 'modelName'>, NamedModel<'VendorBanner'> {
29
+ export interface VendorBanner extends Omit<Banner, 'modelName' | 'tagging'>, NamedModel<'VendorBanner'> {
21
30
  position?: number;
31
+ tagging?: VendorBannerTagging;
22
32
  }
23
33
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/vendor/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEpE,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YACf,SAAQ,IAAI,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC;IACzE,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC;IACzF,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/vendor/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEpE,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YACf,SAAQ,IAAI,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC;IACzE,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,YACf,SAAQ,IAAI,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B"}
@@ -31,6 +31,12 @@ export declare const vendorWiring: {
31
31
  VendorBannersChanged: {
32
32
  setBanners: import("../../wiring").AnyWire;
33
33
  };
34
+ UserViewedAVendorBanner: {
35
+ trackBannerView: import("../../wiring").Wire<import("./types").VendorBanner>;
36
+ };
37
+ UserClickedAVendorBanner: {
38
+ trackBannerClick: import("../../wiring").Wire<import("./types").VendorBanner>;
39
+ };
34
40
  SearchRequestChanged: {
35
41
  resetResults: import("../../wiring").AnyWire;
36
42
  resetBanners: import("../../wiring").AnyWire;
@@ -1 +1 @@
1
- {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/vendor/wiring.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,eAAO,MAAM,UAAU,gCAOtB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,gCAOtB,CAAA;AAgBD;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;CAoBvB,CAAA"}
1
+ {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/vendor/wiring.ts"],"names":[],"mappings":"AA2BA;;;;GAIG;AACH,eAAO,MAAM,UAAU,gCAOtB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,gCAOtB,CAAA;AAgBD;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BvB,CAAA"}