@empathyco/x-components 3.0.0-alpha.386 → 3.0.0-alpha.388

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 (40) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/core/index.js.map +1 -1
  3. package/design-system/deprecated-full-theme.css +72 -72
  4. package/docs/API-reference/api/x-adapter-platform.getdisplayclicktagging.md +26 -0
  5. package/docs/API-reference/api/x-adapter-platform.md +1 -0
  6. package/docs/API-reference/api/x-adapter-platform.platformtagging.displayclick.md +11 -0
  7. package/docs/API-reference/api/x-adapter-platform.platformtagging.md +1 -0
  8. package/docs/API-reference/api/x-components.createtrackdisplaywire.md +26 -0
  9. package/docs/API-reference/api/x-components.displaywiremetadata.displayoriginalquery.md +13 -0
  10. package/docs/API-reference/api/x-components.displaywiremetadata.md +21 -0
  11. package/docs/API-reference/api/x-components.md +3 -0
  12. package/docs/API-reference/api/x-components.usequeriespreview.md +13 -0
  13. package/docs/API-reference/api/x-components.wiremetadata.feature.md +1 -1
  14. package/docs/API-reference/api/x-components.wiremetadata.md +1 -1
  15. package/docs/API-reference/api/x-components.xeventstypes.md +1 -0
  16. package/docs/API-reference/api/x-components.xeventstypes.userclickedadisplayresult.md +13 -0
  17. package/js/index.js +2 -1
  18. package/js/index.js.map +1 -1
  19. package/js/x-modules/queries-preview/composables/use-queries-preview.composable.js +42 -0
  20. package/js/x-modules/queries-preview/composables/use-queries-preview.composable.js.map +1 -0
  21. package/js/x-modules/tagging/wiring.js +25 -2
  22. package/js/x-modules/tagging/wiring.js.map +1 -1
  23. package/package.json +3 -3
  24. package/queries-preview/index.js +1 -0
  25. package/report/x-adapter-platform.api.json +73 -0
  26. package/report/x-components.api.json +233 -1
  27. package/report/x-components.api.md +17 -1
  28. package/tagging/index.js +1 -1
  29. package/types/wiring/events.types.d.ts +5 -0
  30. package/types/wiring/events.types.d.ts.map +1 -1
  31. package/types/wiring/wiring.types.d.ts +12 -2
  32. package/types/wiring/wiring.types.d.ts.map +1 -1
  33. package/types/x-modules/queries-preview/composables/index.d.ts +2 -0
  34. package/types/x-modules/queries-preview/composables/index.d.ts.map +1 -0
  35. package/types/x-modules/queries-preview/composables/use-queries-preview.composable.d.ts +29 -0
  36. package/types/x-modules/queries-preview/composables/use-queries-preview.composable.d.ts.map +1 -0
  37. package/types/x-modules/queries-preview/index.d.ts +1 -0
  38. package/types/x-modules/queries-preview/index.d.ts.map +1 -1
  39. package/types/x-modules/tagging/wiring.d.ts +9 -0
  40. package/types/x-modules/tagging/wiring.d.ts.map +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,24 @@
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
+ ## [3.0.0-alpha.388](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.387...@empathyco/x-components@3.0.0-alpha.388) (2023-06-14)
7
+
8
+ **Note:** Version bump only for package @empathyco/x-components
9
+
10
+
11
+
12
+
13
+
14
+ ## [3.0.0-alpha.387](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.386...@empathyco/x-components@3.0.0-alpha.387) (2023-06-14)
15
+
16
+
17
+ ### Features
18
+
19
+ * **queries-preview:** add isAnyQueryLoadedInPreview composable (#1229) ([5c728e0](https://github.com/empathyco/x/commit/5c728e0304663c601283f1fae2c4dae297caa5ee))
20
+ * **tagging:** track displayClick properties in result & tagging request (#1225) ([53a209e](https://github.com/empathyco/x/commit/53a209e5c9719a8ba0cff21f5d8d52b0dfe70c6d))
21
+
22
+
23
+
6
24
  ## [3.0.0-alpha.386](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.385...@empathyco/x-components@3.0.0-alpha.386) (2023-06-12)
7
25
 
8
26
 
package/core/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/design-system/deprecated-full-theme.css CHANGED
@@ -3444,46 +3444,6 @@
3444
3444
  --x-size-line-height-small: var(--x-size-line-height-base-s);
3445
3445
  --x-string-text-decoration-small: none;
3446
3446
  }
3447
- :root {
3448
- --x-font-family-base: "Montserrat", sans-serif;
3449
- --x-size-font-base-xs: 12px;
3450
- --x-size-font-base-s: 14px;
3451
- --x-size-font-base-m: 16px;
3452
- --x-size-font-base-l: 18px;
3453
- --x-size-font-base-xl: 32px;
3454
- --x-number-font-weight-base-light: 300;
3455
- --x-number-font-weight-base-regular: 400;
3456
- --x-number-font-weight-base-bold: 600;
3457
- --x-size-line-height-base-s: 16px;
3458
- --x-size-line-height-base-m: 24px;
3459
- --x-size-line-height-base-l: 32px;
3460
- --x-color-text-default: var(--x-color-base-neutral-10);
3461
- --x-font-family-text: var(--x-font-family-base);
3462
- --x-size-font-text: var(--x-size-font-base-s);
3463
- --x-number-font-weight-text: var(--x-number-font-weight-base-regular);
3464
- --x-size-line-height-text: var(--x-size-line-height-base-s);
3465
- --x-string-text-decoration-text: none;
3466
- --x-font-family-title1: var(--x-font-family-base);
3467
- --x-size-font-title1: var(--x-size-font-base-xl);
3468
- --x-number-font-weight-title1: var(--x-number-font-weight-base-regular);
3469
- --x-size-line-height-title1: var(--x-size-line-height-base-l);
3470
- --x-string-text-decoration-title1: none;
3471
- --x-font-family-title2: var(--x-font-family-base);
3472
- --x-size-font-title2: var(--x-size-font-base-l);
3473
- --x-number-font-weight-title2: var(--x-number-font-weight-base-regular);
3474
- --x-size-line-height-title2: var(--x-size-line-height-base-m);
3475
- --x-string-text-decoration-title2: none;
3476
- --x-font-family-title3: var(--x-font-family-base);
3477
- --x-size-font-title3: var(--x-size-font-base-m);
3478
- --x-number-font-weight-title3: var(--x-number-font-weight-base-regular);
3479
- --x-size-line-height-title3: var(--x-size-line-height-base-m);
3480
- --x-string-text-decoration-title3: none;
3481
- --x-font-family-small: var(--x-font-family-base);
3482
- --x-size-font-small: var(--x-size-font-base-xs);
3483
- --x-number-font-weight-small: var(--x-number-font-weight-base-regular);
3484
- --x-size-line-height-small: var(--x-size-line-height-base-s);
3485
- --x-string-text-decoration-small: none;
3486
- }
3487
3447
 
3488
3448
  .x,
3489
3449
  .x-text {
@@ -3561,6 +3521,46 @@
3561
3521
  .x-text--bold.x-small {
3562
3522
  --x-number-font-weight-small: var(--x-number-font-weight-base-bold);
3563
3523
  }
3524
+ :root {
3525
+ --x-font-family-base: "Montserrat", sans-serif;
3526
+ --x-size-font-base-xs: 12px;
3527
+ --x-size-font-base-s: 14px;
3528
+ --x-size-font-base-m: 16px;
3529
+ --x-size-font-base-l: 18px;
3530
+ --x-size-font-base-xl: 32px;
3531
+ --x-number-font-weight-base-light: 300;
3532
+ --x-number-font-weight-base-regular: 400;
3533
+ --x-number-font-weight-base-bold: 600;
3534
+ --x-size-line-height-base-s: 16px;
3535
+ --x-size-line-height-base-m: 24px;
3536
+ --x-size-line-height-base-l: 32px;
3537
+ --x-color-text-default: var(--x-color-base-neutral-10);
3538
+ --x-font-family-text: var(--x-font-family-base);
3539
+ --x-size-font-text: var(--x-size-font-base-s);
3540
+ --x-number-font-weight-text: var(--x-number-font-weight-base-regular);
3541
+ --x-size-line-height-text: var(--x-size-line-height-base-s);
3542
+ --x-string-text-decoration-text: none;
3543
+ --x-font-family-title1: var(--x-font-family-base);
3544
+ --x-size-font-title1: var(--x-size-font-base-xl);
3545
+ --x-number-font-weight-title1: var(--x-number-font-weight-base-regular);
3546
+ --x-size-line-height-title1: var(--x-size-line-height-base-l);
3547
+ --x-string-text-decoration-title1: none;
3548
+ --x-font-family-title2: var(--x-font-family-base);
3549
+ --x-size-font-title2: var(--x-size-font-base-l);
3550
+ --x-number-font-weight-title2: var(--x-number-font-weight-base-regular);
3551
+ --x-size-line-height-title2: var(--x-size-line-height-base-m);
3552
+ --x-string-text-decoration-title2: none;
3553
+ --x-font-family-title3: var(--x-font-family-base);
3554
+ --x-size-font-title3: var(--x-size-font-base-m);
3555
+ --x-number-font-weight-title3: var(--x-number-font-weight-base-regular);
3556
+ --x-size-line-height-title3: var(--x-size-line-height-base-m);
3557
+ --x-string-text-decoration-title3: none;
3558
+ --x-font-family-small: var(--x-font-family-base);
3559
+ --x-size-font-small: var(--x-size-font-base-xs);
3560
+ --x-number-font-weight-small: var(--x-number-font-weight-base-regular);
3561
+ --x-size-line-height-small: var(--x-size-line-height-base-s);
3562
+ --x-string-text-decoration-small: none;
3563
+ }
3564
3564
  :root {
3565
3565
  --x-color-text-accent: var(--x-color-base-accent);
3566
3566
  }
@@ -7490,6 +7490,38 @@
7490
7490
  );
7491
7491
  --x-size-line-height-filter-default: var(--x-size-line-height-text);
7492
7492
  }
7493
+ :root {
7494
+ --x-color-background-filter-default: transparent;
7495
+ --x-color-border-filter-default: var(--x-color-background-filter-default);
7496
+ --x-color-text-filter-default: var(--x-color-text-default);
7497
+ --x-color-background-filter-default-selected: var(--x-color-background-filter-default);
7498
+ --x-color-border-filter-default-selected: var(--x-color-border-filter-default);
7499
+ --x-color-text-filter-default-selected: var(--x-color-text-filter-default);
7500
+ --x-size-border-width-filter-default: var(--x-size-border-width-base);
7501
+ --x-size-border-width-top-filter-default: var(--x-size-border-width-filter-default);
7502
+ --x-size-border-width-right-filter-default: var(--x-size-border-width-filter-default);
7503
+ --x-size-border-width-bottom-filter-default: var(--x-size-border-width-filter-default);
7504
+ --x-size-border-width-left-filter-default: var(--x-size-border-width-filter-default);
7505
+ --x-size-border-radius-filter-default: var(--x-size-border-radius-base-none);
7506
+ --x-size-border-radius-top-left-filter-default: var(--x-size-border-radius-filter-default);
7507
+ --x-size-border-radius-top-right-filter-default: var(--x-size-border-radius-filter-default);
7508
+ --x-size-border-radius-bottom-right-filter-default: var(--x-size-border-radius-filter-default);
7509
+ --x-size-border-radius-bottom-left-filter-default: var(--x-size-border-radius-filter-default);
7510
+ --x-size-padding-top-filter-default: var(--x-size-base-03);
7511
+ --x-size-padding-right-filter-default: 0;
7512
+ --x-size-padding-bottom-filter-default: var(--x-size-base-03);
7513
+ --x-size-padding-left-filter-default: 0;
7514
+ --x-size-gap-filter-default: var(--x-size-base-03);
7515
+ --x-font-family-filter-default: var(--x-font-family-text);
7516
+ --x-size-font-filter-default: var(--x-size-font-text);
7517
+ --x-number-font-weight-filter-default: var(--x-number-font-weight-base-regular);
7518
+ --x-number-font-weight-filter-default-selected: var(--x-number-font-weight-base-bold);
7519
+ --x-number-font-weight-filter-count-default: var(--x-number-font-weight-base-light);
7520
+ --x-number-font-weight-filter-count-default-selected: var(
7521
+ --x-number-font-weight-filter-count-default
7522
+ );
7523
+ --x-size-line-height-filter-default: var(--x-size-line-height-text);
7524
+ }
7493
7525
 
7494
7526
  [dir="ltr"] .x-filter,[dir="ltr"] .x-facet-filter {
7495
7527
  padding-left: var(--x-size-padding-left-filter-default);
@@ -8809,36 +8841,4 @@
8809
8841
  --x-size-border-radius-base-m: var(--x-size-base-06);
8810
8842
  --x-size-border-radius-base-pill: 99999px;
8811
8843
  --x-size-border-width-base: 1px;
8812
- }
8813
- :root {
8814
- --x-color-background-filter-default: transparent;
8815
- --x-color-border-filter-default: var(--x-color-background-filter-default);
8816
- --x-color-text-filter-default: var(--x-color-text-default);
8817
- --x-color-background-filter-default-selected: var(--x-color-background-filter-default);
8818
- --x-color-border-filter-default-selected: var(--x-color-border-filter-default);
8819
- --x-color-text-filter-default-selected: var(--x-color-text-filter-default);
8820
- --x-size-border-width-filter-default: var(--x-size-border-width-base);
8821
- --x-size-border-width-top-filter-default: var(--x-size-border-width-filter-default);
8822
- --x-size-border-width-right-filter-default: var(--x-size-border-width-filter-default);
8823
- --x-size-border-width-bottom-filter-default: var(--x-size-border-width-filter-default);
8824
- --x-size-border-width-left-filter-default: var(--x-size-border-width-filter-default);
8825
- --x-size-border-radius-filter-default: var(--x-size-border-radius-base-none);
8826
- --x-size-border-radius-top-left-filter-default: var(--x-size-border-radius-filter-default);
8827
- --x-size-border-radius-top-right-filter-default: var(--x-size-border-radius-filter-default);
8828
- --x-size-border-radius-bottom-right-filter-default: var(--x-size-border-radius-filter-default);
8829
- --x-size-border-radius-bottom-left-filter-default: var(--x-size-border-radius-filter-default);
8830
- --x-size-padding-top-filter-default: var(--x-size-base-03);
8831
- --x-size-padding-right-filter-default: 0;
8832
- --x-size-padding-bottom-filter-default: var(--x-size-base-03);
8833
- --x-size-padding-left-filter-default: 0;
8834
- --x-size-gap-filter-default: var(--x-size-base-03);
8835
- --x-font-family-filter-default: var(--x-font-family-text);
8836
- --x-size-font-filter-default: var(--x-size-font-text);
8837
- --x-number-font-weight-filter-default: var(--x-number-font-weight-base-regular);
8838
- --x-number-font-weight-filter-default-selected: var(--x-number-font-weight-base-bold);
8839
- --x-number-font-weight-filter-count-default: var(--x-number-font-weight-base-light);
8840
- --x-number-font-weight-filter-count-default-selected: var(
8841
- --x-number-font-weight-filter-count-default
8842
- );
8843
- --x-size-line-height-filter-default: var(--x-size-line-height-text);
8844
8844
  }
package/docs/API-reference/api/x-adapter-platform.getdisplayclicktagging.md ADDED
@@ -0,0 +1,26 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [getDisplayClickTagging](./x-adapter-platform.getdisplayclicktagging.md)
4
+
5
+ ## getDisplayClickTagging() function
6
+
7
+ Generates the displayClick tagging info.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function getDisplayClickTagging(displayTaggingUrl: string): TaggingRequest;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | displayTaggingUrl | string | The url containing the displayClick tagging info. |
20
+
21
+ **Returns:**
22
+
23
+ TaggingRequest
24
+
25
+ The object with the tagging info.
26
+
package/docs/API-reference/api/x-adapter-platform.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | Function | Description |
10
10
  | --- | --- |
11
11
  | [extractUrlParameters(url)](./x-adapter-platform.extracturlparameters.md) | Returns the base url path and an object with the query parameters. |
12
+ | [getDisplayClickTagging(displayTaggingUrl)](./x-adapter-platform.getdisplayclicktagging.md) | Generates the displayClick tagging info. |
12
13
  | [getFacetConfig(type)](./x-adapter-platform.getfacetconfig.md) | Returns the facet's config. |
13
14
  | [getTaggingInfoFromUrl(taggingUrl)](./x-adapter-platform.gettagginginfofromurl.md) | Extracts the tagging info from a URL. |
14
15
 
package/docs/API-reference/api/x-adapter-platform.platformtagging.displayclick.md ADDED
@@ -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-adapter-platform](./x-adapter-platform.md) &gt; [PlatformTagging](./x-adapter-platform.platformtagging.md) &gt; [displayClick](./x-adapter-platform.platformtagging.displayclick.md)
4
+
5
+ ## PlatformTagging.displayClick property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ displayClick: string;
11
+ ```
package/docs/API-reference/api/x-adapter-platform.platformtagging.md CHANGED
@@ -19,4 +19,5 @@ export interface PlatformTagging
19
19
  | [add2cart](./x-adapter-platform.platformtagging.add2cart.md) | | string | |
20
20
  | [checkout](./x-adapter-platform.platformtagging.checkout.md) | | string | |
21
21
  | [click](./x-adapter-platform.platformtagging.click.md) | | string | |
22
+ | [displayClick](./x-adapter-platform.platformtagging.displayclick.md) | | string | |
22
23
 
package/docs/API-reference/api/x-components.createtrackdisplaywire.md ADDED
@@ -0,0 +1,26 @@
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; [createTrackDisplayWire](./x-components.createtrackdisplaywire.md)
4
+
5
+ ## createTrackDisplayWire() function
6
+
7
+ Factory helper to create a wire for the track of the display click.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function createTrackDisplayWire(property: keyof Tagging): Wire<Taggable>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | property | keyof Tagging | Key of the tagging object to track. |
20
+
21
+ **Returns:**
22
+
23
+ [Wire](./x-components.wire.md)<!-- -->&lt;Taggable&gt;
24
+
25
+ A new wire for the display click of the taggable element.
26
+
package/docs/API-reference/api/x-components.displaywiremetadata.displayoriginalquery.md ADDED
@@ -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; [DisplayWireMetadata](./x-components.displaywiremetadata.md) &gt; [displayOriginalQuery](./x-components.displaywiremetadata.displayoriginalquery.md)
4
+
5
+ ## DisplayWireMetadata.displayOriginalQuery property
6
+
7
+ The query that originated the display elements appearing.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ displayOriginalQuery: string;
13
+ ```
package/docs/API-reference/api/x-components.displaywiremetadata.md ADDED
@@ -0,0 +1,21 @@
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; [DisplayWireMetadata](./x-components.displaywiremetadata.md)
4
+
5
+ ## DisplayWireMetadata interface
6
+
7
+ Wire metadata specific for display wires.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface DisplayWireMetadata extends WireMetadata
13
+ ```
14
+ **Extends:** [WireMetadata](./x-components.wiremetadata.md)
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [displayOriginalQuery](./x-components.displaywiremetadata.displayoriginalquery.md) | | string | The query that originated the display elements appearing. |
21
+
package/docs/API-reference/api/x-components.md CHANGED
@@ -148,6 +148,7 @@ X-Components is a library usable everywhere not only for search experiences.
148
148
  | [createFetchAndSaveActions({ fetch, onSuccess, onError, onCancel })](./x-components.createfetchandsaveactions.md) | Utility to create an action that requests and save some data asynchronously, with the option to cancel the request at any moment. This factory provides with the standard flow for requesting, cancelling, handling errors for a module, while also taking care of its status. |
149
149
  | [createRawFilters(filterIds)](./x-components.createrawfilters.md) | Helper method which creates the filter entity from the filter ir of the url. |
150
150
  | [createStoreEmitters(storeModule, emitters)](./x-components.createstoreemitters.md) | Helper function for creating type-safe [StoreEmitters](./x-components.storeemitters.md)<!-- -->. |
151
+ | [createTrackDisplayWire(property)](./x-components.createtrackdisplaywire.md) | Factory helper to create a wire for the track of the display click. |
151
152
  | [createTrackWire(property)](./x-components.createtrackwire.md) | Factory helper to create a wire for the track of a taggable element. |
152
153
  | [createUseDevice(devices)](./x-components.createusedevice.md) | Factory function that creates a composable for device detection using the devices parameter to configure breakpoints. |
153
154
  | [createWireFromFunction(fn)](./x-components.createwirefromfunction.md) | Creates a wire that executes the function passed. This function will receive a [WireParams](./x-components.wireparams.md) object. |
@@ -216,6 +217,7 @@ X-Components is a library usable everywhere not only for search experiences.
216
217
  | [DeviceMutations](./x-components.devicemutations.md) | Device store mutations. |
217
218
  | [DeviceState](./x-components.devicestate.md) | Device store state. |
218
219
  | [DeviceXEvents](./x-components.devicexevents.md) | Dictionary of the events of [DeviceXModule](./x-components.devicexmodule.md)<!-- -->, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
220
+ | [DisplayWireMetadata](./x-components.displaywiremetadata.md) | Wire metadata specific for display wires. |
219
221
  | [EmpathizeActions](./x-components.empathizeactions.md) | Empathize store actions. |
220
222
  | [EmpathizeConfig](./x-components.empathizeconfig.md) | Configuration options for the [EmpathizeXModule](./x-components.empathizexmodule.md)<!-- -->. |
221
223
  | [EmpathizeGetters](./x-components.empathizegetters.md) | Empathize store getters. |
@@ -648,6 +650,7 @@ X-Components is a library usable everywhere not only for search experiences.
648
650
  | [TrendingTinyIcon](./x-components.trendingtinyicon.md) | |
649
651
  | [updateHistoryQueriesWithSearchResponse](./x-components.updatehistoryquerieswithsearchresponse.md) | Updates the history queries with the relevant info included in a search response. |
650
652
  | [urlXModule](./x-components.urlxmodule.md) | URL [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>url</code> entry point. |
653
+ | [useQueriesPreview](./x-components.usequeriespreview.md) | Composable helpers for the QueriesPreview module. |
651
654
  | [UserFilledIcon](./x-components.userfilledicon.md) | |
652
655
  | [UserIcon](./x-components.usericon.md) | |
653
656
  | [xPlugin](./x-components.xplugin.md) | Vue plugin that modifies each component instance, extending them with the [X Component API](./x-components.xcomponentapi.md)<!-- -->. |
package/docs/API-reference/api/x-components.usequeriespreview.md ADDED
@@ -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; [useQueriesPreview](./x-components.usequeriespreview.md)
4
+
5
+ ## useQueriesPreview variable
6
+
7
+ Composable helpers for the QueriesPreview module.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ useQueriesPreview: () => UseQueriesPreview
13
+ ```
package/docs/API-reference/api/x-components.wiremetadata.feature.md CHANGED
@@ -9,5 +9,5 @@ The [QueryFeature](./x-components.queryfeature.md) that originated the event.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- feature?: QueryFeature;
12
+ feature?: QueryFeature | ResultFeature;
13
13
  ```
package/docs/API-reference/api/x-components.wiremetadata.md CHANGED
@@ -17,7 +17,7 @@ export interface WireMetadata
17
17
  | Property | Modifiers | Type | Description |
18
18
  | --- | --- | --- | --- |
19
19
  | [component?](./x-components.wiremetadata.component.md) | | Vue | _(Optional)_ The component instance that triggered the event emission. |
20
- | [feature?](./x-components.wiremetadata.feature.md) | | [QueryFeature](./x-components.queryfeature.md) | _(Optional)_ The [QueryFeature](./x-components.queryfeature.md) that originated the event. |
20
+ | [feature?](./x-components.wiremetadata.feature.md) | | [QueryFeature](./x-components.queryfeature.md) \| [ResultFeature](./x-components.resultfeature.md) | _(Optional)_ The [QueryFeature](./x-components.queryfeature.md) that originated the event. |
21
21
  | [id?](./x-components.wiremetadata.id.md) | | string | _(Optional)_ The id of the component origin. |
22
22
  | [ignoreInModules?](./x-components.wiremetadata.ignoreinmodules.md) | | [XModuleName](./x-components.xmodulename.md)<!-- -->\[\] | _(Optional)_ The event can be ignored if it is received in the wiring of the modules in the array. |
23
23
  | [location?](./x-components.wiremetadata.location.md) | | [FeatureLocation](./x-components.featurelocation.md) | _(Optional)_ The [FeatureLocation](./x-components.featurelocation.md) from where the event has been emitted. |
package/docs/API-reference/api/x-components.xeventstypes.md CHANGED
@@ -29,6 +29,7 @@ Aside from common [XEvents](./x-components.xevent.md)<!-- -->, this interface al
29
29
  | [TogglePanelStateChanged](./x-components.xeventstypes.togglepanelstatechanged.md) | | boolean | The <code>BaseToggleIdPanel</code> <code>isOpen</code> state changed. Payload: the new state. |
30
30
  | [UserAcceptedAQuery](./x-components.xeventstypes.useracceptedaquery.md) | | string | The user has accepted a query Payload: the accepted query. |
31
31
  | [UserAcceptedSpellcheckQuery](./x-components.xeventstypes.useracceptedspellcheckquery.md) | | string | The user has accepted the spellcheck Payload: the spellcheck query. |
32
+ | [UserClickedADisplayResult](./x-components.xeventstypes.userclickedadisplayresult.md) | | Result | The user has clicked on a display result. Payload: The [result](./x-types.result.md) that the user clicked. |
32
33
  | [UserClickedAResult](./x-components.xeventstypes.userclickedaresult.md) | | Result | The user has clicked on a result. Payload: The [result](./x-types.result.md) that the user clicked. |
33
34
  | [UserClickedAResultRating](./x-components.xeventstypes.userclickedaresultrating.md) | | Result | The user has clicked on the rating of a result. Payload: The [result](./x-types.result.md) that the user clicked. |
34
35
  | [UserClickedCloseEventsModal](./x-components.xeventstypes.userclickedcloseeventsmodal.md) | | void | The user clicked the button to close the events modal. Payload: none. |
package/docs/API-reference/api/x-components.xeventstypes.userclickedadisplayresult.md ADDED
@@ -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; [XEventsTypes](./x-components.xeventstypes.md) &gt; [UserClickedADisplayResult](./x-components.xeventstypes.userclickedadisplayresult.md)
4
+
5
+ ## XEventsTypes.UserClickedADisplayResult property
6
+
7
+ The user has clicked on a display result. Payload: The [result](./x-types.result.md) that the user clicked.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ UserClickedADisplayResult: Result;
13
+ ```
package/js/index.js CHANGED
@@ -297,6 +297,7 @@ export { popularSearchesWiring, setPopularSearchesExtraParams, setSearchedQuerie
297
297
  export { popularSearchesXModule } from './x-modules/popular-searches/x-module.js';
298
298
  export { default as QueryPreview } from './x-modules/queries-preview/components/query-preview.vue.js';
299
299
  export { default as QueryPreviewList } from './x-modules/queries-preview/components/query-preview-list.vue.js';
300
+ export { useQueriesPreview } from './x-modules/queries-preview/composables/use-queries-preview.composable.js';
300
301
  export { fetchQueryPreview } from './x-modules/queries-preview/store/actions/fetch-query-preview.action.js';
301
302
  export { fetchAndSaveQueryPreview } from './x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.js';
302
303
  export { queriesPreviewEmitters } from './x-modules/queries-preview/store/emitters.js';
@@ -394,7 +395,7 @@ export { DefaultPDPAddToCartService } from './x-modules/tagging/service/pdp-add-
394
395
  export { track } from './x-modules/tagging/store/actions/track.action.js';
395
396
  export { taggingEmitters } from './x-modules/tagging/store/emitters.js';
396
397
  export { taggingXStoreModule } from './x-modules/tagging/store/module.js';
397
- export { createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackDisplayClickedWire, trackQueryWire, trackResultClickedWire } from './x-modules/tagging/wiring.js';
398
+ export { createTrackDisplayWire, createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackDisplayClickedWire, trackQueryWire, trackResultClickedWire } from './x-modules/tagging/wiring.js';
398
399
  export { taggingXModule } from './x-modules/tagging/x-module.js';
399
400
  export { default as UrlHandler } from './x-modules/url/components/url-handler.vue.js';
400
401
  export { replaceableParams, urlEmitters } from './x-modules/url/store/emitters.js';
package/js/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/js/x-modules/queries-preview/composables/use-queries-preview.composable.js ADDED
@@ -0,0 +1,42 @@
1
+ import { computed } from 'vue';
2
+ import { XPlugin } from '../../../plugins/x-plugin.js';
3
+
4
+ /**
5
+ * Composable helpers for the QueriesPreview module.
6
+ *
7
+ * @returns Composable with helpers.
8
+ *
9
+ * @public
10
+ */
11
+ const useQueriesPreview = () => {
12
+ const store = XPlugin.store;
13
+ const loadedQueriesPreview = computed(() => store.getters['x/queriesPreview/loadedQueriesPreview']);
14
+ const loadedQueries = computed(() => {
15
+ return Object.keys(loadedQueriesPreview.value);
16
+ });
17
+ /**
18
+ * Checks if the query passed has results in the queries preview.
19
+ *
20
+ * @param query - The query to check.
21
+ * @returns True if the query has results.
22
+ */
23
+ const isQueryLoadedInPreview = (query) => {
24
+ return loadedQueries.value.includes(query);
25
+ };
26
+ /**
27
+ * Checks if any of the queries passed have results in the queries previews.
28
+ *
29
+ * @param queries - The queries to check.
30
+ * @returns True if some query has results.
31
+ */
32
+ const isAnyQueryLoadedInPreview = (queries) => {
33
+ return queries.some(isQueryLoadedInPreview);
34
+ };
35
+ return {
36
+ isAnyQueryLoadedInPreview,
37
+ isQueryLoadedInPreview
38
+ };
39
+ };
40
+
41
+ export { useQueriesPreview };
42
+ //# sourceMappingURL=use-queries-preview.composable.js.map
package/js/x-modules/queries-preview/composables/use-queries-preview.composable.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-queries-preview.composable.js","sources":["../../../../../src/x-modules/queries-preview/composables/use-queries-preview.composable.ts"],"sourcesContent":["import { computed } from 'vue';\nimport { QueriesPreviewGetters } from '../store';\nimport { XPlugin } from '../../../plugins/x-plugin';\n\n/**\n * Composable helpers for the QueriesPreview module.\n */\ninterface UseQueriesPreview {\n /**\n * Checks if any of the queries passed have results in the queries previews.\n *\n * @param queries - The queries to check.\n * @returns True if some query has results.\n */\n isAnyQueryLoadedInPreview: (queries: string[]) => boolean;\n /**\n * Checks if the query passed has results in the queries preview.\n *\n * @param query - The query to check.\n * @returns True if the query has results.\n */\n isQueryLoadedInPreview: (query: string) => boolean;\n}\n\n/**\n * Composable helpers for the QueriesPreview module.\n *\n * @returns Composable with helpers.\n *\n * @public\n */\nexport const useQueriesPreview = (): UseQueriesPreview => {\n const store = XPlugin.store;\n const loadedQueriesPreview = computed<QueriesPreviewGetters['loadedQueriesPreview']>(\n () => store.getters['x/queriesPreview/loadedQueriesPreview']\n );\n const loadedQueries = computed(() => {\n return Object.keys(loadedQueriesPreview.value);\n });\n\n /**\n * Checks if the query passed has results in the queries preview.\n *\n * @param query - The query to check.\n * @returns True if the query has results.\n */\n const isQueryLoadedInPreview: UseQueriesPreview['isQueryLoadedInPreview'] = (\n query: string\n ): boolean => {\n return loadedQueries.value.includes(query);\n };\n\n /**\n * Checks if any of the queries passed have results in the queries previews.\n *\n * @param queries - The queries to check.\n * @returns True if some query has results.\n */\n const isAnyQueryLoadedInPreview: UseQueriesPreview['isAnyQueryLoadedInPreview'] = (\n queries: string[]\n ): boolean => {\n return queries.some(isQueryLoadedInPreview);\n };\n\n return {\n isAnyQueryLoadedInPreview,\n isQueryLoadedInPreview\n };\n};\n"],"names":[],"mappings":";;;AAwBA;;;;;;AAMG;AACI,MAAM,iBAAiB,GAAG,MAAwB;AACvD,IAAA,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;AAC5B,IAAA,MAAM,oBAAoB,GAAG,QAAQ,CACnC,MAAM,KAAK,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAC7D,CAAC;AACF,IAAA,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAK;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;AACjD,KAAC,CAAC,CAAC;AAEH;;;;;AAKG;AACH,IAAA,MAAM,sBAAsB,GAAgD,CAC1E,KAAa,KACF;QACX,OAAO,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7C,KAAC,CAAC;AAEF;;;;;AAKG;AACH,IAAA,MAAM,yBAAyB,GAAmD,CAChF,OAAiB,KACN;AACX,QAAA,OAAO,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAC9C,KAAC,CAAC;IAEF,OAAO;QACL,yBAAyB;QACzB,sBAAsB;KACvB,CAAC;AACJ;;;;"}
package/js/x-modules/tagging/wiring.js CHANGED
@@ -4,6 +4,8 @@ import { namespacedDebounce } from '../../wiring/namespaced-wires.operators.js';
4
4
  import { wireServiceWithoutPayload, wireService } from '../../wiring/wires.factory.js';
5
5
  import { filter, mapWire } from '../../wiring/wires.operators.js';
6
6
  import { createWiring } from '../../wiring/wiring.utils.js';
7
+ import { createOrigin } from '../../utils/origin.js';
8
+ import '../../utils/storage.js';
7
9
  import { DefaultPDPAddToCartService } from './service/pdp-add-to-cart.service.js';
8
10
 
9
11
  /**
@@ -119,7 +121,7 @@ const trackAddToCartWire = createTrackWire('add2cart');
119
121
  *
120
122
  * @public
121
123
  */
122
- const trackDisplayClickedWire = createTrackWire('displayClick');
124
+ const trackDisplayClickedWire = createTrackDisplayWire('displayClick');
123
125
  /**
124
126
  * Factory helper to create a wire for the track of a taggable element.
125
127
  *
@@ -135,6 +137,27 @@ function createTrackWire(property) {
135
137
  return taggingInfo;
136
138
  }), ({ eventPayload: { tagging }, metadata: { ignoreInModules } }) => !!tagging?.[property] && !ignoreInModules?.includes(moduleName));
137
139
  }
140
+ /**
141
+ * Factory helper to create a wire for the track of the display click.
142
+ *
143
+ * @param property - Key of the tagging object to track.
144
+ * @returns A new wire for the display click of the taggable element.
145
+ *
146
+ * @public
147
+ */
148
+ function createTrackDisplayWire(property) {
149
+ return filter(wireDispatch('track', ({ eventPayload: { tagging }, metadata }) => {
150
+ const taggingInfo = tagging[property];
151
+ const location = metadata.location;
152
+ taggingInfo.params.location = location;
153
+ taggingInfo.params.displayFamily = createOrigin({
154
+ feature: metadata.feature,
155
+ location
156
+ });
157
+ taggingInfo.params.q = metadata.displayOriginalQuery;
158
+ return taggingInfo;
159
+ }), ({ eventPayload: { tagging } }) => !!tagging?.[property]);
160
+ }
138
161
  /**
139
162
  * Wiring configuration for the {@link TaggingXModule | tagging module}.
140
163
  *
@@ -181,5 +204,5 @@ const taggingWiring = createWiring({
181
204
  }
182
205
  });
183
206
 
184
- export { createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackDisplayClickedWire, trackQueryWire, trackResultClickedWire };
207
+ export { createTrackDisplayWire, createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackDisplayClickedWire, trackQueryWire, trackResultClickedWire };
185
208
  //# sourceMappingURL=wiring.js.map
package/js/x-modules/tagging/wiring.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import { Taggable, Tagging, TaggingRequest } from '@empathyco/x-types';\nimport { DefaultSessionService } from '@empathyco/x-utils';\nimport {\n namespacedWireCommit,\n namespacedWireDispatch\n} from '../../wiring/namespaced-wires.factory';\nimport { namespacedDebounce } from '../../wiring/namespaced-wires.operators';\nimport { wireService, wireServiceWithoutPayload } from '../../wiring/wires.factory';\nimport { filter, mapWire } from '../../wiring/wires.operators';\nimport { Wire } from '../../wiring/wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { DefaultPDPAddToCartService } from './service/pdp-add-to-cart.service';\n\n/**\n * `tagging` {@link XModuleName | XModule name}.\n *\n * @internal\n */\nconst moduleName = 'tagging';\n\n/**\n * Debounce function for the module.\n */\nconst moduleDebounce = namespacedDebounce(moduleName);\n\n/**\n * WireCommit for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName);\n\n/**\n * WireDispatch for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireDispatch = namespacedWireDispatch(moduleName);\n\n/**\n * Wires without payload factory for {@link DefaultSessionService}.\n */\nconst wireSessionServiceWithoutPayload = wireServiceWithoutPayload(DefaultSessionService.instance);\n\n/**\n * Wires factory for {@link DefaultPDPAddToCartService}.\n */\nconst wirePDPAddToCartService = wireService(DefaultPDPAddToCartService.instance);\n\n/**\n * Stores the given result on the local storage.\n *\n * @public\n */\nconst storeClickedResultWire = wirePDPAddToCartService('storeResultClicked');\n\n/**\n * Moves the result information from the local storage to session storage.\n *\n * @public\n */\nconst moveClickedResultToSessionWire = mapWire(\n wirePDPAddToCartService('moveToSessionStorage'),\n (payload: string) => {\n return payload === 'url' ? undefined : payload;\n }\n);\n\n/**\n * Triggers the add to cart tracking.\n *\n * @public\n */\nconst trackAddToCartFromSessionStorage = wirePDPAddToCartService('trackAddToCart');\n\n/**\n * Clears the session id.\n *\n * @public\n */\nconst clearSessionWire = filter(\n wireSessionServiceWithoutPayload('clearSessionId'),\n ({ eventPayload: consent }) => !consent\n);\n\n/**\n * Sets the tagging state `consent`.\n *\n * @public\n */\nexport const setConsent = wireCommit('setConsent');\n\n/**\n * Sets the tagging config state.\n *\n * @public\n */\nexport const setTaggingConfig = wireCommit('setTaggingConfig');\n\n/**\n * Tracks the tagging of the query.\n *\n * @public\n */\nexport const trackQueryWire = wireDispatch('track');\n\n/**\n * Sets the tagging state of the query tagging info using a debounce which ends if the user\n * accepts a query.\n *\n * @public\n */\nexport const setQueryTaggingInfo = moduleDebounce(\n wireCommit('setQueryTaggingInfo'),\n ({ state }) => state.config.queryTaggingDebounceMs,\n {\n cancelOn: 'UserClearedQuery',\n forceOn: [\n 'UserClickedAResult',\n 'UserClickedAPromoted',\n 'UserClickedABanner',\n 'UserClickedARedirection',\n 'UserReachedResultsListEnd'\n ]\n }\n);\n\n/**\n * Tracks the tagging of the result.\n *\n * @public\n */\nexport const trackResultClickedWire = createTrackWire('click');\n\n/**\n * Tracks the tagging of the banner.\n *\n * @public\n */\nexport const trackBannerClickedWire = createTrackWire('click');\n\n/**\n * Performs a track of a result added to the cart.\n *\n * @public\n */\nexport const trackAddToCartWire = createTrackWire('add2cart');\n\n/**\n * Performs a track of a display result being clicked.\n *\n * @public\n */\nexport const trackDisplayClickedWire = createTrackWire('displayClick');\n\n/**\n * Factory helper to create a wire for the track of a taggable element.\n *\n * @param property - Key of the tagging object to track.\n * @returns A new wire for the given property of the taggable element.\n *\n * @public\n */\nexport function createTrackWire(property: keyof Tagging): Wire<Taggable> {\n return filter(\n wireDispatch('track', ({ eventPayload: { tagging }, metadata: { location } }) => {\n const taggingInfo: TaggingRequest = tagging[property];\n taggingInfo.params.location = location as string;\n return taggingInfo;\n }),\n ({ eventPayload: { tagging }, metadata: { ignoreInModules } }) =>\n !!tagging?.[property] && !ignoreInModules?.includes(moduleName)\n );\n}\n\n/**\n * Wiring configuration for the {@link TaggingXModule | tagging module}.\n *\n * @internal\n */\nexport const taggingWiring = createWiring({\n ConsentProvided: {\n setConsent\n },\n ConsentChanged: {\n clearSessionWire\n },\n PDPIsLoaded: {\n moveClickedResultToSessionWire\n },\n ResultURLTrackingEnabled: {\n moveClickedResultToSessionWire\n },\n SearchTaggingChanged: {\n setQueryTaggingInfo\n },\n SearchTaggingReceived: {\n trackQueryWire\n },\n TaggingConfigProvided: {\n setTaggingConfig\n },\n UserClickedAResult: {\n trackResultClickedWire,\n storeClickedResultWire\n },\n UserClickedResultAddToCart: {\n trackAddToCartWire,\n trackResultClickedWire\n },\n UserClickedPDPAddToCart: {\n trackAddToCartFromSessionStorage\n },\n UserClickedABanner: {\n trackBannerClickedWire\n },\n UserClickedADisplayResult: {\n trackDisplayClickedWire\n }\n});\n"],"names":[],"mappings":";;;;;;;;AAaA;;;;AAIG;AACH,MAAM,UAAU,GAAG,SAAS,CAAC;AAE7B;;AAEG;AACH,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;AAEtD;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAEpD;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAExD;;AAEG;AACH,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AAEnG;;AAEG;AACH,MAAM,uBAAuB,GAAG,WAAW,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AAEjF;;;;AAIG;AACH,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;AAE7E;;;;AAIG;AACH,MAAM,8BAA8B,GAAG,OAAO,CAC5C,uBAAuB,CAAC,sBAAsB,CAAC,EAC/C,CAAC,OAAe,KAAI;IAClB,OAAO,OAAO,KAAK,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC;AACjD,CAAC,CACF,CAAC;AAEF;;;;AAIG;AACH,MAAM,gCAAgC,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;AAEnF;;;;AAIG;AACH,MAAM,gBAAgB,GAAG,MAAM,CAC7B,gCAAgC,CAAC,gBAAgB,CAAC,EAClD,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CACxC,CAAC;AAEF;;;;AAIG;MACU,UAAU,GAAG,UAAU,CAAC,YAAY,EAAE;AAEnD;;;;AAIG;MACU,gBAAgB,GAAG,UAAU,CAAC,kBAAkB,EAAE;AAE/D;;;;AAIG;MACU,cAAc,GAAG,YAAY,CAAC,OAAO,EAAE;AAEpD;;;;;AAKG;MACU,mBAAmB,GAAG,cAAc,CAC/C,UAAU,CAAC,qBAAqB,CAAC,EACjC,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,sBAAsB,EAClD;AACE,IAAA,QAAQ,EAAE,kBAAkB;AAC5B,IAAA,OAAO,EAAE;QACP,oBAAoB;QACpB,sBAAsB;QACtB,oBAAoB;QACpB,yBAAyB;QACzB,2BAA2B;AAC5B,KAAA;AACF,CAAA,EACD;AAEF;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAE;AAE/D;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAE;AAE/D;;;;AAIG;MACU,kBAAkB,GAAG,eAAe,CAAC,UAAU,EAAE;AAE9D;;;;AAIG;MACU,uBAAuB,GAAG,eAAe,CAAC,cAAc,EAAE;AAEvE;;;;;;;AAOG;AACG,SAAU,eAAe,CAAC,QAAuB,EAAA;IACrD,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAI;AAC9E,QAAA,MAAM,WAAW,GAAmB,OAAO,CAAC,QAAQ,CAAC,CAAC;AACtD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAkB,CAAC;AACjD,QAAA,OAAO,WAAW,CAAC;AACrB,KAAC,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,EAAE,KAC3D,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;AAIG;AACI,MAAM,aAAa,GAAG,YAAY,CAAC;AACxC,IAAA,eAAe,EAAE;QACf,UAAU;AACX,KAAA;AACD,IAAA,cAAc,EAAE;QACd,gBAAgB;AACjB,KAAA;AACD,IAAA,WAAW,EAAE;QACX,8BAA8B;AAC/B,KAAA;AACD,IAAA,wBAAwB,EAAE;QACxB,8BAA8B;AAC/B,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,mBAAmB;AACpB,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,cAAc;AACf,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,gBAAgB;AACjB,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;QACtB,sBAAsB;AACvB,KAAA;AACD,IAAA,0BAA0B,EAAE;QAC1B,kBAAkB;QAClB,sBAAsB;AACvB,KAAA;AACD,IAAA,uBAAuB,EAAE;QACvB,gCAAgC;AACjC,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;AACvB,KAAA;AACD,IAAA,yBAAyB,EAAE;QACzB,uBAAuB;AACxB,KAAA;AACF,CAAA;;;;"}
1
+ {"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import { Taggable, Tagging, TaggingRequest } from '@empathyco/x-types';\nimport { DefaultSessionService } from '@empathyco/x-utils';\nimport {\n namespacedWireCommit,\n namespacedWireDispatch\n} from '../../wiring/namespaced-wires.factory';\nimport { namespacedDebounce } from '../../wiring/namespaced-wires.operators';\nimport { wireService, wireServiceWithoutPayload } from '../../wiring/wires.factory';\nimport { filter, mapWire } from '../../wiring/wires.operators';\nimport { DisplayWireMetadata, Wire } from '../../wiring/wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { createOrigin } from '../../utils/index';\nimport { FeatureLocation } from '../../types/index';\nimport { DefaultPDPAddToCartService } from './service/pdp-add-to-cart.service';\n\n/**\n * `tagging` {@link XModuleName | XModule name}.\n *\n * @internal\n */\nconst moduleName = 'tagging';\n\n/**\n * Debounce function for the module.\n */\nconst moduleDebounce = namespacedDebounce(moduleName);\n\n/**\n * WireCommit for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName);\n\n/**\n * WireDispatch for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireDispatch = namespacedWireDispatch(moduleName);\n\n/**\n * Wires without payload factory for {@link DefaultSessionService}.\n */\nconst wireSessionServiceWithoutPayload = wireServiceWithoutPayload(DefaultSessionService.instance);\n\n/**\n * Wires factory for {@link DefaultPDPAddToCartService}.\n */\nconst wirePDPAddToCartService = wireService(DefaultPDPAddToCartService.instance);\n\n/**\n * Stores the given result on the local storage.\n *\n * @public\n */\nconst storeClickedResultWire = wirePDPAddToCartService('storeResultClicked');\n\n/**\n * Moves the result information from the local storage to session storage.\n *\n * @public\n */\nconst moveClickedResultToSessionWire = mapWire(\n wirePDPAddToCartService('moveToSessionStorage'),\n (payload: string) => {\n return payload === 'url' ? undefined : payload;\n }\n);\n\n/**\n * Triggers the add to cart tracking.\n *\n * @public\n */\nconst trackAddToCartFromSessionStorage = wirePDPAddToCartService('trackAddToCart');\n\n/**\n * Clears the session id.\n *\n * @public\n */\nconst clearSessionWire = filter(\n wireSessionServiceWithoutPayload('clearSessionId'),\n ({ eventPayload: consent }) => !consent\n);\n\n/**\n * Sets the tagging state `consent`.\n *\n * @public\n */\nexport const setConsent = wireCommit('setConsent');\n\n/**\n * Sets the tagging config state.\n *\n * @public\n */\nexport const setTaggingConfig = wireCommit('setTaggingConfig');\n\n/**\n * Tracks the tagging of the query.\n *\n * @public\n */\nexport const trackQueryWire = wireDispatch('track');\n\n/**\n * Sets the tagging state of the query tagging info using a debounce which ends if the user\n * accepts a query.\n *\n * @public\n */\nexport const setQueryTaggingInfo = moduleDebounce(\n wireCommit('setQueryTaggingInfo'),\n ({ state }) => state.config.queryTaggingDebounceMs,\n {\n cancelOn: 'UserClearedQuery',\n forceOn: [\n 'UserClickedAResult',\n 'UserClickedAPromoted',\n 'UserClickedABanner',\n 'UserClickedARedirection',\n 'UserReachedResultsListEnd'\n ]\n }\n);\n\n/**\n * Tracks the tagging of the result.\n *\n * @public\n */\nexport const trackResultClickedWire = createTrackWire('click');\n\n/**\n * Tracks the tagging of the banner.\n *\n * @public\n */\nexport const trackBannerClickedWire = createTrackWire('click');\n\n/**\n * Performs a track of a result added to the cart.\n *\n * @public\n */\nexport const trackAddToCartWire = createTrackWire('add2cart');\n\n/**\n * Performs a track of a display result being clicked.\n *\n * @public\n */\nexport const trackDisplayClickedWire = createTrackDisplayWire('displayClick');\n\n/**\n * Factory helper to create a wire for the track of a taggable element.\n *\n * @param property - Key of the tagging object to track.\n * @returns A new wire for the given property of the taggable element.\n *\n * @public\n */\nexport function createTrackWire(property: keyof Tagging): Wire<Taggable> {\n return filter(\n wireDispatch('track', ({ eventPayload: { tagging }, metadata: { location } }) => {\n const taggingInfo: TaggingRequest = tagging[property];\n taggingInfo.params.location = location as string;\n return taggingInfo;\n }),\n ({ eventPayload: { tagging }, metadata: { ignoreInModules } }) =>\n !!tagging?.[property] && !ignoreInModules?.includes(moduleName)\n );\n}\n\n/**\n * Factory helper to create a wire for the track of the display click.\n *\n * @param property - Key of the tagging object to track.\n * @returns A new wire for the display click of the taggable element.\n *\n * @public\n */\nexport function createTrackDisplayWire(property: keyof Tagging): Wire<Taggable> {\n return filter(\n wireDispatch('track', ({ eventPayload: { tagging }, metadata }) => {\n const taggingInfo: TaggingRequest = tagging[property];\n const location = metadata.location as FeatureLocation;\n\n taggingInfo.params.location = location;\n taggingInfo.params.displayFamily = createOrigin({\n feature: metadata.feature,\n location\n })!;\n taggingInfo.params.q = (metadata as DisplayWireMetadata).displayOriginalQuery;\n\n return taggingInfo;\n }),\n ({ eventPayload: { tagging } }) => !!tagging?.[property]\n );\n}\n\n/**\n * Wiring configuration for the {@link TaggingXModule | tagging module}.\n *\n * @internal\n */\nexport const taggingWiring = createWiring({\n ConsentProvided: {\n setConsent\n },\n ConsentChanged: {\n clearSessionWire\n },\n PDPIsLoaded: {\n moveClickedResultToSessionWire\n },\n ResultURLTrackingEnabled: {\n moveClickedResultToSessionWire\n },\n SearchTaggingChanged: {\n setQueryTaggingInfo\n },\n SearchTaggingReceived: {\n trackQueryWire\n },\n TaggingConfigProvided: {\n setTaggingConfig\n },\n UserClickedAResult: {\n trackResultClickedWire,\n storeClickedResultWire\n },\n UserClickedResultAddToCart: {\n trackAddToCartWire,\n trackResultClickedWire\n },\n UserClickedPDPAddToCart: {\n trackAddToCartFromSessionStorage\n },\n UserClickedABanner: {\n trackBannerClickedWire\n },\n UserClickedADisplayResult: {\n trackDisplayClickedWire\n }\n});\n"],"names":[],"mappings":";;;;;;;;;;AAeA;;;;AAIG;AACH,MAAM,UAAU,GAAG,SAAS,CAAC;AAE7B;;AAEG;AACH,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;AAEtD;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAEpD;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAExD;;AAEG;AACH,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AAEnG;;AAEG;AACH,MAAM,uBAAuB,GAAG,WAAW,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AAEjF;;;;AAIG;AACH,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;AAE7E;;;;AAIG;AACH,MAAM,8BAA8B,GAAG,OAAO,CAC5C,uBAAuB,CAAC,sBAAsB,CAAC,EAC/C,CAAC,OAAe,KAAI;IAClB,OAAO,OAAO,KAAK,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC;AACjD,CAAC,CACF,CAAC;AAEF;;;;AAIG;AACH,MAAM,gCAAgC,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;AAEnF;;;;AAIG;AACH,MAAM,gBAAgB,GAAG,MAAM,CAC7B,gCAAgC,CAAC,gBAAgB,CAAC,EAClD,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CACxC,CAAC;AAEF;;;;AAIG;MACU,UAAU,GAAG,UAAU,CAAC,YAAY,EAAE;AAEnD;;;;AAIG;MACU,gBAAgB,GAAG,UAAU,CAAC,kBAAkB,EAAE;AAE/D;;;;AAIG;MACU,cAAc,GAAG,YAAY,CAAC,OAAO,EAAE;AAEpD;;;;;AAKG;MACU,mBAAmB,GAAG,cAAc,CAC/C,UAAU,CAAC,qBAAqB,CAAC,EACjC,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,sBAAsB,EAClD;AACE,IAAA,QAAQ,EAAE,kBAAkB;AAC5B,IAAA,OAAO,EAAE;QACP,oBAAoB;QACpB,sBAAsB;QACtB,oBAAoB;QACpB,yBAAyB;QACzB,2BAA2B;AAC5B,KAAA;AACF,CAAA,EACD;AAEF;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAE;AAE/D;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAE;AAE/D;;;;AAIG;MACU,kBAAkB,GAAG,eAAe,CAAC,UAAU,EAAE;AAE9D;;;;AAIG;MACU,uBAAuB,GAAG,sBAAsB,CAAC,cAAc,EAAE;AAE9E;;;;;;;AAOG;AACG,SAAU,eAAe,CAAC,QAAuB,EAAA;IACrD,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAI;AAC9E,QAAA,MAAM,WAAW,GAAmB,OAAO,CAAC,QAAQ,CAAC,CAAC;AACtD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAkB,CAAC;AACjD,QAAA,OAAO,WAAW,CAAC;AACrB,KAAC,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,EAAE,KAC3D,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,sBAAsB,CAAC,QAAuB,EAAA;AAC5D,IAAA,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAI;AAChE,QAAA,MAAM,WAAW,GAAmB,OAAO,CAAC,QAAQ,CAAC,CAAC;AACtD,QAAA,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAA2B,CAAC;AAEtD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvC,QAAA,WAAW,CAAC,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YAC9C,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,QAAQ;AACT,SAAA,CAAE,CAAC;QACJ,WAAW,CAAC,MAAM,CAAC,CAAC,GAAI,QAAgC,CAAC,oBAAoB,CAAC;AAE9E,QAAA,OAAO,WAAW,CAAC;KACpB,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,CACzD,CAAC;AACJ,CAAC;AAED;;;;AAIG;AACI,MAAM,aAAa,GAAG,YAAY,CAAC;AACxC,IAAA,eAAe,EAAE;QACf,UAAU;AACX,KAAA;AACD,IAAA,cAAc,EAAE;QACd,gBAAgB;AACjB,KAAA;AACD,IAAA,WAAW,EAAE;QACX,8BAA8B;AAC/B,KAAA;AACD,IAAA,wBAAwB,EAAE;QACxB,8BAA8B;AAC/B,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,mBAAmB;AACpB,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,cAAc;AACf,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,gBAAgB;AACjB,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;QACtB,sBAAsB;AACvB,KAAA;AACD,IAAA,0BAA0B,EAAE;QAC1B,kBAAkB;QAClB,sBAAsB;AACvB,KAAA;AACD,IAAA,uBAAuB,EAAE;QACvB,gCAAgC;AACjC,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;AACvB,KAAA;AACD,IAAA,yBAAyB,EAAE;QACzB,uBAAuB;AACxB,KAAA;AACF,CAAA;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@empathyco/x-components",
3
- "version": "3.0.0-alpha.386",
3
+ "version": "3.0.0-alpha.388",
4
4
  "description": "Empathy X Components",
5
5
  "author": "Empathy Systems Corporation S.L.",
6
6
  "license": "Apache-2.0",
@@ -68,7 +68,7 @@
68
68
  },
69
69
  "dependencies": {
70
70
  "@empathyco/x-adapter": "^8.0.0-alpha.31",
71
- "@empathyco/x-adapter-platform": "^1.0.0-alpha.77",
71
+ "@empathyco/x-adapter-platform": "^1.0.0-alpha.78",
72
72
  "@empathyco/x-bus": "^1.0.0-alpha.2",
73
73
  "@empathyco/x-deep-merge": "^2.0.0-alpha.1",
74
74
  "@empathyco/x-logger": "^1.2.0-alpha.11",
@@ -143,5 +143,5 @@
143
143
  "access": "public",
144
144
  "directory": "dist"
145
145
  },
146
- "gitHead": "b1b79aa39db575a85fb67416119bb5d3e8312da5"
146
+ "gitHead": "677d0fc9da4da921c540218b475bd6a54e64b1a3"
147
147
  }
package/queries-preview/index.js CHANGED
@@ -1,5 +1,6 @@
1
1
  export { default as QueryPreview } from '../js/x-modules/queries-preview/components/query-preview.vue.js';
2
2
  export { default as QueryPreviewList } from '../js/x-modules/queries-preview/components/query-preview-list.vue.js';
3
+ export { useQueriesPreview } from '../js/x-modules/queries-preview/composables/use-queries-preview.composable.js';
3
4
  export { fetchQueryPreview } from '../js/x-modules/queries-preview/store/actions/fetch-query-preview.action.js';
4
5
  export { fetchAndSaveQueryPreview } from '../js/x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.js';
5
6
  export { queriesPreviewEmitters } from '../js/x-modules/queries-preview/store/emitters.js';
package/report/x-adapter-platform.api.json CHANGED
@@ -427,6 +427,52 @@
427
427
  "endIndex": 14
428
428
  }
429
429
  },
430
+ {
431
+ "kind": "Function",
432
+ "canonicalReference": "@empathyco/x-adapter-platform!getDisplayClickTagging:function(1)",
433
+ "docComment": "/**\n * Generates the displayClick tagging info.\n *\n * @param displayTaggingUrl - The url containing the displayClick tagging info.\n *\n * @returns The object with the tagging info.\n *\n * @public\n */\n",
434
+ "excerptTokens": [
435
+ {
436
+ "kind": "Content",
437
+ "text": "export declare function getDisplayClickTagging(displayTaggingUrl: "
438
+ },
439
+ {
440
+ "kind": "Content",
441
+ "text": "string"
442
+ },
443
+ {
444
+ "kind": "Content",
445
+ "text": "): "
446
+ },
447
+ {
448
+ "kind": "Reference",
449
+ "text": "TaggingRequest",
450
+ "canonicalReference": "@empathyco/x-adapter-platform!TaggingRequest:interface"
451
+ },
452
+ {
453
+ "kind": "Content",
454
+ "text": ";"
455
+ }
456
+ ],
457
+ "fileUrlPath": "dist/types/mappers/url.utils.d.ts",
458
+ "returnTypeTokenRange": {
459
+ "startIndex": 3,
460
+ "endIndex": 4
461
+ },
462
+ "releaseTag": "Public",
463
+ "overloadIndex": 1,
464
+ "parameters": [
465
+ {
466
+ "parameterName": "displayTaggingUrl",
467
+ "parameterTypeTokenRange": {
468
+ "startIndex": 1,
469
+ "endIndex": 2
470
+ },
471
+ "isOptional": false
472
+ }
473
+ ],
474
+ "name": "getDisplayClickTagging"
475
+ },
430
476
  {
431
477
  "kind": "Function",
432
478
  "canonicalReference": "@empathyco/x-adapter-platform!getFacetConfig:function(1)",
@@ -4298,6 +4344,33 @@
4298
4344
  "startIndex": 1,
4299
4345
  "endIndex": 2
4300
4346
  }
4347
+ },
4348
+ {
4349
+ "kind": "PropertySignature",
4350
+ "canonicalReference": "@empathyco/x-adapter-platform!PlatformTagging#displayClick:member",
4351
+ "docComment": "",
4352
+ "excerptTokens": [
4353
+ {
4354
+ "kind": "Content",
4355
+ "text": "displayClick: "
4356
+ },
4357
+ {
4358
+ "kind": "Content",
4359
+ "text": "string"
4360
+ },
4361
+ {
4362
+ "kind": "Content",
4363
+ "text": ";"
4364
+ }
4365
+ ],
4366
+ "isReadonly": false,
4367
+ "isOptional": false,
4368
+ "releaseTag": "Public",
4369
+ "name": "displayClick",
4370
+ "propertyTypeTokenRange": {
4371
+ "startIndex": 1,
4372
+ "endIndex": 2
4373
+ }
4301
4374
  }
4302
4375
  ],
4303
4376
  "extendsTokenRanges": []
package/report/x-components.api.json CHANGED
@@ -11278,6 +11278,70 @@
11278
11278
  ],
11279
11279
  "name": "createStoreEmitters"
11280
11280
  },
11281
+ {
11282
+ "kind": "Function",
11283
+ "canonicalReference": "@empathyco/x-components!createTrackDisplayWire:function(1)",
11284
+ "docComment": "/**\n * Factory helper to create a wire for the track of the display click.\n *\n * @param property - Key of the tagging object to track.\n *\n * @returns A new wire for the display click of the taggable element.\n *\n * @public\n */\n",
11285
+ "excerptTokens": [
11286
+ {
11287
+ "kind": "Content",
11288
+ "text": "export declare function createTrackDisplayWire(property: "
11289
+ },
11290
+ {
11291
+ "kind": "Content",
11292
+ "text": "keyof "
11293
+ },
11294
+ {
11295
+ "kind": "Reference",
11296
+ "text": "Tagging",
11297
+ "canonicalReference": "@empathyco/x-components!Tagging_2:interface"
11298
+ },
11299
+ {
11300
+ "kind": "Content",
11301
+ "text": "): "
11302
+ },
11303
+ {
11304
+ "kind": "Reference",
11305
+ "text": "Wire",
11306
+ "canonicalReference": "@empathyco/x-components!Wire:type"
11307
+ },
11308
+ {
11309
+ "kind": "Content",
11310
+ "text": "<"
11311
+ },
11312
+ {
11313
+ "kind": "Reference",
11314
+ "text": "Taggable",
11315
+ "canonicalReference": "@empathyco/x-components!Taggable:interface"
11316
+ },
11317
+ {
11318
+ "kind": "Content",
11319
+ "text": ">"
11320
+ },
11321
+ {
11322
+ "kind": "Content",
11323
+ "text": ";"
11324
+ }
11325
+ ],
11326
+ "fileUrlPath": "src/x-modules/tagging/wiring.ts",
11327
+ "returnTypeTokenRange": {
11328
+ "startIndex": 4,
11329
+ "endIndex": 8
11330
+ },
11331
+ "releaseTag": "Public",
11332
+ "overloadIndex": 1,
11333
+ "parameters": [
11334
+ {
11335
+ "parameterName": "property",
11336
+ "parameterTypeTokenRange": {
11337
+ "startIndex": 1,
11338
+ "endIndex": 3
11339
+ },
11340
+ "isOptional": false
11341
+ }
11342
+ ],
11343
+ "name": "createTrackDisplayWire"
11344
+ },
11281
11345
  {
11282
11346
  "kind": "Function",
11283
11347
  "canonicalReference": "@empathyco/x-components!createTrackWire:function(1)",
@@ -14460,6 +14524,65 @@
14460
14524
  },
14461
14525
  "implementsTokenRanges": []
14462
14526
  },
14527
+ {
14528
+ "kind": "Interface",
14529
+ "canonicalReference": "@empathyco/x-components!DisplayWireMetadata:interface",
14530
+ "docComment": "/**\n * Wire metadata specific for display wires.\n *\n * @public\n */\n",
14531
+ "excerptTokens": [
14532
+ {
14533
+ "kind": "Content",
14534
+ "text": "export interface DisplayWireMetadata extends "
14535
+ },
14536
+ {
14537
+ "kind": "Reference",
14538
+ "text": "WireMetadata",
14539
+ "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
14540
+ },
14541
+ {
14542
+ "kind": "Content",
14543
+ "text": " "
14544
+ }
14545
+ ],
14546
+ "fileUrlPath": "src/wiring/wiring.types.ts",
14547
+ "releaseTag": "Public",
14548
+ "name": "DisplayWireMetadata",
14549
+ "preserveMemberOrder": false,
14550
+ "members": [
14551
+ {
14552
+ "kind": "PropertySignature",
14553
+ "canonicalReference": "@empathyco/x-components!DisplayWireMetadata#displayOriginalQuery:member",
14554
+ "docComment": "/**\n * The query that originated the display elements appearing.\n */\n",
14555
+ "excerptTokens": [
14556
+ {
14557
+ "kind": "Content",
14558
+ "text": "displayOriginalQuery: "
14559
+ },
14560
+ {
14561
+ "kind": "Content",
14562
+ "text": "string"
14563
+ },
14564
+ {
14565
+ "kind": "Content",
14566
+ "text": ";"
14567
+ }
14568
+ ],
14569
+ "isReadonly": false,
14570
+ "isOptional": false,
14571
+ "releaseTag": "Public",
14572
+ "name": "displayOriginalQuery",
14573
+ "propertyTypeTokenRange": {
14574
+ "startIndex": 1,
14575
+ "endIndex": 2
14576
+ }
14577
+ }
14578
+ ],
14579
+ "extendsTokenRanges": [
14580
+ {
14581
+ "startIndex": 1,
14582
+ "endIndex": 2
14583
+ }
14584
+ ]
14585
+ },
14463
14586
  {
14464
14587
  "kind": "TypeAlias",
14465
14588
  "canonicalReference": "@empathyco/x-components!DocumentDirection:type",
@@ -60666,6 +60789,34 @@
60666
60789
  "endIndex": 14
60667
60790
  }
60668
60791
  },
60792
+ {
60793
+ "kind": "Variable",
60794
+ "canonicalReference": "@empathyco/x-components!useQueriesPreview:var",
60795
+ "docComment": "/**\n * Composable helpers for the QueriesPreview module.\n *\n * @returns Composable with helpers.\n *\n * @public\n */\n",
60796
+ "excerptTokens": [
60797
+ {
60798
+ "kind": "Content",
60799
+ "text": "useQueriesPreview: "
60800
+ },
60801
+ {
60802
+ "kind": "Content",
60803
+ "text": "() => "
60804
+ },
60805
+ {
60806
+ "kind": "Reference",
60807
+ "text": "UseQueriesPreview",
60808
+ "canonicalReference": "@empathyco/x-components!~UseQueriesPreview:interface"
60809
+ }
60810
+ ],
60811
+ "fileUrlPath": "src/x-modules/queries-preview/composables/use-queries-preview.composable.ts",
60812
+ "isReadonly": true,
60813
+ "releaseTag": "Public",
60814
+ "name": "useQueriesPreview",
60815
+ "variableTypeTokenRange": {
60816
+ "startIndex": 1,
60817
+ "endIndex": 3
60818
+ }
60819
+ },
60669
60820
  {
60670
60821
  "kind": "Variable",
60671
60822
  "canonicalReference": "@empathyco/x-components!UserFilledIcon:var",
@@ -61759,6 +61910,50 @@
61759
61910
  "name": "WireMetadata",
61760
61911
  "preserveMemberOrder": false,
61761
61912
  "members": [
61913
+ {
61914
+ "kind": "IndexSignature",
61915
+ "canonicalReference": "@empathyco/x-components!WireMetadata:index(1)",
61916
+ "docComment": "",
61917
+ "excerptTokens": [
61918
+ {
61919
+ "kind": "Content",
61920
+ "text": "[key: "
61921
+ },
61922
+ {
61923
+ "kind": "Content",
61924
+ "text": "string"
61925
+ },
61926
+ {
61927
+ "kind": "Content",
61928
+ "text": "]: "
61929
+ },
61930
+ {
61931
+ "kind": "Content",
61932
+ "text": "unknown"
61933
+ },
61934
+ {
61935
+ "kind": "Content",
61936
+ "text": ";"
61937
+ }
61938
+ ],
61939
+ "isReadonly": false,
61940
+ "returnTypeTokenRange": {
61941
+ "startIndex": 3,
61942
+ "endIndex": 4
61943
+ },
61944
+ "releaseTag": "Public",
61945
+ "overloadIndex": 1,
61946
+ "parameters": [
61947
+ {
61948
+ "parameterName": "key",
61949
+ "parameterTypeTokenRange": {
61950
+ "startIndex": 1,
61951
+ "endIndex": 2
61952
+ },
61953
+ "isOptional": false
61954
+ }
61955
+ ]
61956
+ },
61762
61957
  {
61763
61958
  "kind": "PropertySignature",
61764
61959
  "canonicalReference": "@empathyco/x-components!WireMetadata#component:member",
@@ -61801,6 +61996,15 @@
61801
61996
  "text": "QueryFeature",
61802
61997
  "canonicalReference": "@empathyco/x-components!QueryFeature:type"
61803
61998
  },
61999
+ {
62000
+ "kind": "Content",
62001
+ "text": " | "
62002
+ },
62003
+ {
62004
+ "kind": "Reference",
62005
+ "text": "ResultFeature",
62006
+ "canonicalReference": "@empathyco/x-components!ResultFeature:type"
62007
+ },
61804
62008
  {
61805
62009
  "kind": "Content",
61806
62010
  "text": ";"
@@ -61812,7 +62016,7 @@
61812
62016
  "name": "feature",
61813
62017
  "propertyTypeTokenRange": {
61814
62018
  "startIndex": 1,
61815
- "endIndex": 2
62019
+ "endIndex": 4
61816
62020
  }
61817
62021
  },
61818
62022
  {
@@ -66023,6 +66227,34 @@
66023
66227
  "endIndex": 2
66024
66228
  }
66025
66229
  },
66230
+ {
66231
+ "kind": "PropertySignature",
66232
+ "canonicalReference": "@empathyco/x-components!XEventsTypes#UserClickedADisplayResult:member",
66233
+ "docComment": "/**\n * The user has clicked on a display result. Payload: The {@link @empathyco/x-types#Result | result} that the user clicked.\n */\n",
66234
+ "excerptTokens": [
66235
+ {
66236
+ "kind": "Content",
66237
+ "text": "UserClickedADisplayResult: "
66238
+ },
66239
+ {
66240
+ "kind": "Reference",
66241
+ "text": "Result",
66242
+ "canonicalReference": "@empathyco/x-components!Result:interface"
66243
+ },
66244
+ {
66245
+ "kind": "Content",
66246
+ "text": ";"
66247
+ }
66248
+ ],
66249
+ "isReadonly": false,
66250
+ "isOptional": false,
66251
+ "releaseTag": "Public",
66252
+ "name": "UserClickedADisplayResult",
66253
+ "propertyTypeTokenRange": {
66254
+ "startIndex": 1,
66255
+ "endIndex": 2
66256
+ }
66257
+ },
66026
66258
  {
66027
66259
  "kind": "PropertySignature",
66028
66260
  "canonicalReference": "@empathyco/x-components!XEventsTypes#UserClickedAResult:member",
package/report/x-components.api.md CHANGED
@@ -1193,6 +1193,9 @@ export function createStoreEmitters<Module extends AnyXStoreModule, Emitters ext
1193
1193
  // Warning: (ae-forgotten-export) The symbol "Tagging_2" needs to be exported by the entry point index.d.ts
1194
1194
  // Warning: (ae-forgotten-export) The symbol "Taggable" needs to be exported by the entry point index.d.ts
1195
1195
  //
1196
+ // @public
1197
+ export function createTrackDisplayWire(property: keyof Tagging_2): Wire<Taggable>;
1198
+
1196
1199
  // @public
1197
1200
  export function createTrackWire(property: keyof Tagging_2): Wire<Taggable>;
1198
1201
 
@@ -1460,6 +1463,11 @@ export class DisableAnimationMixin extends Vue_2 {
1460
1463
  protected get name(): string;
1461
1464
  }
1462
1465
 
1466
+ // @public
1467
+ export interface DisplayWireMetadata extends WireMetadata {
1468
+ displayOriginalQuery: string;
1469
+ }
1470
+
1463
1471
  // @public
1464
1472
  export type DocumentDirection = 'ltr' | 'rtl';
1465
1473
 
@@ -5784,6 +5792,11 @@ export type UseDeviceReturn<Device extends string = string> = {
5784
5792
  deviceName: Ref<string>;
5785
5793
  } & UseDeviceFlags<Device>;
5786
5794
 
5795
+ // Warning: (ae-forgotten-export) The symbol "UseQueriesPreview" needs to be exported by the entry point index.d.ts
5796
+ //
5797
+ // @public
5798
+ export const useQueriesPreview: () => UseQueriesPreview;
5799
+
5787
5800
  // @public (undocumented)
5788
5801
  export const UserFilledIcon: {};
5789
5802
 
@@ -5854,8 +5867,10 @@ export type WireForEvent<Event extends XEvent> = Wire<XEventPayload<Event>>;
5854
5867
 
5855
5868
  // @public
5856
5869
  export interface WireMetadata {
5870
+ // (undocumented)
5871
+ [key: string]: unknown;
5857
5872
  component?: Vue;
5858
- feature?: QueryFeature;
5873
+ feature?: QueryFeature | ResultFeature;
5859
5874
  id?: string;
5860
5875
  ignoreInModules?: XModuleName[];
5861
5876
  location?: FeatureLocation;
@@ -6035,6 +6050,7 @@ export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraPara
6035
6050
  TogglePanelStateChanged: boolean;
6036
6051
  UserAcceptedAQuery: string;
6037
6052
  UserAcceptedSpellcheckQuery: string;
6053
+ UserClickedADisplayResult: Result;
6038
6054
  UserClickedAResult: Result;
6039
6055
  UserClickedAResultRating: Result;
6040
6056
  UserClickedCloseEventsModal: void;
package/tagging/index.js CHANGED
@@ -3,5 +3,5 @@ export { DefaultPDPAddToCartService } from '../js/x-modules/tagging/service/pdp-
3
3
  export { track } from '../js/x-modules/tagging/store/actions/track.action.js';
4
4
  export { taggingEmitters } from '../js/x-modules/tagging/store/emitters.js';
5
5
  export { taggingXStoreModule } from '../js/x-modules/tagging/store/module.js';
6
- export { createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackDisplayClickedWire, trackQueryWire, trackResultClickedWire } from '../js/x-modules/tagging/wiring.js';
6
+ export { createTrackDisplayWire, createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackDisplayClickedWire, trackQueryWire, trackResultClickedWire } from '../js/x-modules/tagging/wiring.js';
7
7
  export { taggingXModule } from '../js/x-modules/tagging/x-module.js';
package/types/wiring/events.types.d.ts CHANGED
@@ -84,6 +84,11 @@ export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraPara
84
84
  * Payload: The {@link @empathyco/x-types#Result | result} that the user clicked.
85
85
  */
86
86
  UserClickedAResult: Result;
87
+ /**
88
+ * The user has clicked on a display result.
89
+ * Payload: The {@link @empathyco/x-types#Result | result} that the user clicked.
90
+ */
91
+ UserClickedADisplayResult: Result;
87
92
  /**
88
93
  * The user clicked the button to close the events modal.
89
94
  * Payload: none.
package/types/wiring/events.types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,YACf,SAAQ,aAAa,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,UAAU;IACZ;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;OAGG;IACH,oBAAoB,EAAE,UAAU,EAAE,CAAC;IACnC;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,0BAA0B,EAAE,IAAI,CAAC;IACjC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,gBAAgB,EAAE,IAAI,CAAC;IACvB;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,mBAAmB,EAAE,QAAQ,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,EAAE,IAAI,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF;;;OAGG;IACH,uBAAuB,EAAE,UAAU,CAAC;IACpC;;;;OAIG;IACH,uBAAuB,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,cAAc,EAAE,OAAO,CAAC;QACxB,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;QAChC,QAAQ,EAAE,YAAY,CAAC;KACxB,CAAC;IACF;;;OAGG;IACH,gBAAgB,EAAE,WAAW,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,IAAI,IAAI,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,IAAI,GAC9E,SAAS,GACT,YAAY,CAAC,KAAK,CAAC,CAAC"}
1
+ {"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,YACf,SAAQ,aAAa,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,UAAU;IACZ;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;OAGG;IACH,oBAAoB,EAAE,UAAU,EAAE,CAAC;IACnC;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,0BAA0B,EAAE,IAAI,CAAC;IACjC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,gBAAgB,EAAE,IAAI,CAAC;IACvB;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,mBAAmB,EAAE,QAAQ,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,EAAE,IAAI,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF;;;OAGG;IACH,uBAAuB,EAAE,UAAU,CAAC;IACpC;;;;OAIG;IACH,uBAAuB,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,cAAc,EAAE,OAAO,CAAC;QACxB,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;QAChC,QAAQ,EAAE,YAAY,CAAC;KACxB,CAAC;IACF;;;OAGG;IACH,gBAAgB,EAAE,WAAW,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,IAAI,IAAI,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,IAAI,GAC9E,SAAS,GACT,YAAY,CAAC,KAAK,CAAC,CAAC"}
package/types/wiring/wiring.types.d.ts CHANGED
@@ -3,7 +3,7 @@ import { Dictionary } from '@empathyco/x-utils';
3
3
  import { Observable, Subscription } from 'rxjs';
4
4
  import { Store } from 'vuex';
5
5
  import { RootStoreStateAndGetters, RootXStoreState } from '../store/store.types';
6
- import { FeatureLocation, QueryFeature } from '../types/origin';
6
+ import { FeatureLocation, QueryFeature, ResultFeature } from '../types/origin';
7
7
  import { FirstParameter, MaybeArray, MonadicFunction, NiladicFunction } from '../utils/types';
8
8
  import { XModuleName } from '../x-modules/x-modules.types';
9
9
  import { XEvent, XEventPayload, XEventsTypes } from './events.types';
@@ -24,7 +24,7 @@ export type Wire<PayloadType> = (observable: Observable<WirePayload<PayloadType>
24
24
  */
25
25
  export interface WireMetadata {
26
26
  /** The {@link QueryFeature} that originated the event. */
27
- feature?: QueryFeature;
27
+ feature?: QueryFeature | ResultFeature;
28
28
  /** The id of the component origin. */
29
29
  id?: string;
30
30
  /** The {@link FeatureLocation} from where the event has been emitted. */
@@ -51,6 +51,16 @@ export interface WireMetadata {
51
51
  * The event can be ignored if it is received in the wiring of the modules in the array.
52
52
  */
53
53
  ignoreInModules?: XModuleName[];
54
+ [key: string]: unknown;
55
+ }
56
+ /**
57
+ * Wire metadata specific for display wires.
58
+ *
59
+ * @public
60
+ */
61
+ export interface DisplayWireMetadata extends WireMetadata {
62
+ /** The query that originated the display elements appearing. */
63
+ displayOriginalQuery: string;
54
64
  }
55
65
  /**
56
66
  * The wire payload includes the payload of the event, and a {@link WireMetadata} object to add
package/types/wiring/wiring.types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"wiring.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/wiring.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,MAAM,IAAI,CAAC,WAAW,IAAI,CAC9B,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAChD,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,EAC7B,EAAE,EAAE,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,KAC/C,YAAY,CAAC;AAElB;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,sCAAsC;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;;OAGG;IACH,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,gEAAgE;IAChE,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW,CAAE,SAAQ,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC;CAAG;AAE9F;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,OAAO,IAAI,wBAAwB,GAAG;IACnE,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,CAAC,KAAK,SAAS,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG;KAClB,KAAK,IAAI,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,UAAU,CAAC,OAAO,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,MAAM,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC9B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IAC9E;;;;;;OAMG;IACH,CAAC,UAAU,SAAS,MAAM,WAAW,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI,CAC9D,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CACxC,CAAC;IACF;;;;;;OAMG;IACH,CAAC,UAAU,SAAS,MAAM,WAAW,EACnC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,GAC/C,OAAO,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IAC5F;;;;;OAKG;IACH,CAAC,UAAU,SAAS,MAAM,WAAW,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;CACrE"}
1
+ {"version":3,"file":"wiring.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/wiring.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,MAAM,IAAI,CAAC,WAAW,IAAI,CAC9B,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAChD,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,EAC7B,EAAE,EAAE,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,KAC/C,YAAY,CAAC;AAElB;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;IACvC,sCAAsC;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;;OAGG;IACH,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,gEAAgE;IAChE,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,EAAE,CAAC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,gEAAgE;IAChE,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW,CAAE,SAAQ,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC;CAAG;AAE9F;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,OAAO,IAAI,wBAAwB,GAAG;IACnE,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,CAAC,KAAK,SAAS,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG;KAClB,KAAK,IAAI,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,UAAU,CAAC,OAAO,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,MAAM,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC9B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IAC9E;;;;;;OAMG;IACH,CAAC,UAAU,SAAS,MAAM,WAAW,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI,CAC9D,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CACxC,CAAC;IACF;;;;;;OAMG;IACH,CAAC,UAAU,SAAS,MAAM,WAAW,EACnC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,GAC/C,OAAO,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IAC5F;;;;;OAKG;IACH,CAAC,UAAU,SAAS,MAAM,WAAW,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;CACrE"}
package/types/x-modules/queries-preview/composables/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export * from './use-queries-preview.composable';
2
+ //# sourceMappingURL=index.d.ts.map
package/types/x-modules/queries-preview/composables/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/composables/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC"}
package/types/x-modules/queries-preview/composables/use-queries-preview.composable.d.ts ADDED
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Composable helpers for the QueriesPreview module.
3
+ */
4
+ interface UseQueriesPreview {
5
+ /**
6
+ * Checks if any of the queries passed have results in the queries previews.
7
+ *
8
+ * @param queries - The queries to check.
9
+ * @returns True if some query has results.
10
+ */
11
+ isAnyQueryLoadedInPreview: (queries: string[]) => boolean;
12
+ /**
13
+ * Checks if the query passed has results in the queries preview.
14
+ *
15
+ * @param query - The query to check.
16
+ * @returns True if the query has results.
17
+ */
18
+ isQueryLoadedInPreview: (query: string) => boolean;
19
+ }
20
+ /**
21
+ * Composable helpers for the QueriesPreview module.
22
+ *
23
+ * @returns Composable with helpers.
24
+ *
25
+ * @public
26
+ */
27
+ export declare const useQueriesPreview: () => UseQueriesPreview;
28
+ export {};
29
+ //# sourceMappingURL=use-queries-preview.composable.d.ts.map
package/types/x-modules/queries-preview/composables/use-queries-preview.composable.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-queries-preview.composable.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/composables/use-queries-preview.composable.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,UAAU,iBAAiB;IACzB;;;;;OAKG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAC1D;;;;;OAKG;IACH,sBAAsB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,QAAO,iBAqCpC,CAAC"}
package/types/x-modules/queries-preview/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from './components';
2
+ export * from './composables';
2
3
  export * from './config.types';
3
4
  export * from './events.types';
4
5
  export * from './store';
package/types/x-modules/queries-preview/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/queries-preview/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/queries-preview/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
package/types/x-modules/tagging/wiring.d.ts CHANGED
@@ -58,6 +58,15 @@ export declare const trackDisplayClickedWire: Wire<Taggable>;
58
58
  * @public
59
59
  */
60
60
  export declare function createTrackWire(property: keyof Tagging): Wire<Taggable>;
61
+ /**
62
+ * Factory helper to create a wire for the track of the display click.
63
+ *
64
+ * @param property - Key of the tagging object to track.
65
+ * @returns A new wire for the display click of the taggable element.
66
+ *
67
+ * @public
68
+ */
69
+ export declare function createTrackDisplayWire(property: keyof Tagging): Wire<Taggable>;
61
70
  /**
62
71
  * Wiring configuration for the {@link TaggingXModule | tagging module}.
63
72
  *
package/types/x-modules/tagging/wiring.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/tagging/wiring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AASvE,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AA4EjD;;;;GAIG;AACH,eAAO,MAAM,UAAU,eAA2B,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,8CAAiC,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,cAAc,yCAAwB,CAAC;AAEpD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,sBAa/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,gBAA8B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,gBAAkC,CAAC;AAEvE;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAUvE;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCxB,CAAC"}
1
+ {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/tagging/wiring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AASvE,OAAO,EAAuB,IAAI,EAAE,MAAM,2BAA2B,CAAC;AA8EtE;;;;GAIG;AACH,eAAO,MAAM,UAAU,eAA2B,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,8CAAiC,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,cAAc,yCAAwB,CAAC;AAEpD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,sBAa/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,gBAA8B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,gBAAyC,CAAC;AAE9E;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAUvE;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAiB9E;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCxB,CAAC"}