@coveo/quantic 3.11.0 → 3.12.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 (103) hide show
  1. package/README.md +1 -1
  2. package/docs/out/quantic-docs.json +27 -0
  3. package/force-app/main/default/lwc/quanticBreadcrumbManager/__tests__/quanticBreadcrumbManager.test.js +610 -0
  4. package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/fixture.ts +76 -0
  5. package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/pageObject.ts +282 -0
  6. package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/quanticBreadcrumbManager.e2e.ts +167 -0
  7. package/force-app/main/default/lwc/quanticBreadcrumbManager/quanticBreadcrumbManager.html +10 -10
  8. package/force-app/main/default/lwc/quanticBreadcrumbManager/quanticBreadcrumbManager.js +8 -8
  9. package/force-app/main/default/lwc/quanticFeedbackModalQna/templates/quanticFeedbackModalQna.html +1 -0
  10. package/force-app/main/default/lwc/quanticGeneratedAnswer/__tests__/quanticGeneratedAnswer.test.js +538 -21
  11. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/data.ts +56 -0
  12. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/fixture.ts +87 -0
  13. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/pageObject.ts +279 -0
  14. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/quanticGeneratedAnswer.e2e.ts +178 -0
  15. package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/generatedAnswer.html +24 -10
  16. package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/retryPrompt.html +2 -2
  17. package/force-app/main/default/lwc/quanticGeneratedAnswerToggle/quanticGeneratedAnswerToggle.html +1 -1
  18. package/force-app/main/default/lwc/quanticPager/e2e/fixture.ts +4 -4
  19. package/force-app/main/default/lwc/quanticPager/e2e/{pagerObject.ts → pageObject.ts} +1 -1
  20. package/force-app/main/default/lwc/quanticTab/__tests__/quanticTab.test.js +287 -0
  21. package/force-app/main/default/lwc/quanticTab/e2e/fixture.ts +62 -0
  22. package/force-app/main/default/lwc/quanticTab/e2e/pageObject.ts +67 -0
  23. package/force-app/main/default/lwc/quanticTab/e2e/quanticTab.e2e.ts +77 -0
  24. package/force-app/main/default/lwc/quanticTab/quanticTab.html +1 -1
  25. package/force-app/main/default/lwc/quanticTabBar/__tests__/quanticTabBar.test.js +331 -0
  26. package/force-app/main/default/lwc/quanticTabBar/e2e/fixture.ts +61 -0
  27. package/force-app/main/default/lwc/quanticTabBar/e2e/pageObject.ts +80 -0
  28. package/force-app/main/default/lwc/quanticTabBar/e2e/quanticTabBar.e2e.ts +173 -0
  29. package/force-app/main/default/lwc/quanticTabBar/quanticTabBar.html +30 -8
  30. package/force-app/main/default/lwc/quanticTabBar/quanticTabBar.js +5 -4
  31. package/force-app/main/default/lwc/quanticUserActionsToggle/e2e/pageObject.ts +1 -1
  32. package/force-app/main/default/lwc/quanticUserActionsToggle/quanticUserActionsToggle.js +4 -0
  33. package/force-app/main/default/lwc/quanticUtils/__tests__/markdownUtils.test.js +1 -1
  34. package/force-app/main/default/staticresources/coveobueno/browser/bueno.js +4 -4
  35. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -10
  36. package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/instant-result-analytics.d.ts +1 -1
  37. package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts +1 -1
  38. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +1 -1
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +4 -2
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts +1 -1
  41. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-params.d.ts +1 -1
  42. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-params.d.ts +2 -2
  43. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-engine/commerce-engine.ssr.d.ts +2 -0
  44. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/factories/build-factory.d.ts +2 -0
  45. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/factories/utils/recommendation-filter.d.ts +11 -0
  46. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/common.d.ts +12 -2
  47. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/kind.d.ts +9 -0
  48. package/force-app/main/default/staticresources/coveoheadless/definitions/app/undoable.d.ts +0 -3
  49. package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts +1 -1
  50. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.d.ts +1 -0
  51. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.d.ts +3 -0
  52. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.d.ts +7 -6
  53. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.d.ts +3 -1
  54. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.d.ts +1 -2
  55. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.ssr.d.ts +2 -1
  56. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/url-manager/headless-core-url-manager.d.ts +11 -2
  57. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-list/headless-product-list.ssr.d.ts +1 -1
  58. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-view/headless-product-view.ssr.d.ts +1 -0
  59. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts +1 -0
  60. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/example-deleteme-headless-case-context.d.ts +1 -1
  61. package/force-app/main/default/staticresources/coveoheadless/definitions/features/actions-history/ipx-actions-history-actions.d.ts +1 -1
  62. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +3 -3
  63. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-actions.d.ts +22 -6
  64. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-schema.d.ts +4 -0
  65. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-selectors.d.ts +0 -11
  66. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.d.ts +8 -2
  67. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.ssr.d.ts +44 -0
  68. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-slice.d.ts +4 -0
  69. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-state.d.ts +4 -0
  70. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +1 -0
  71. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-state.d.ts +1 -0
  72. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts +0 -12
  73. package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/debug-selectors.d.ts +1 -1
  74. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-analytics-actions.d.ts +1 -1
  75. package/force-app/main/default/staticresources/coveoheadless/definitions/features/history/history-actions.d.ts +3 -3
  76. package/force-app/main/default/staticresources/coveoheadless/definitions/features/pipeline/select-pipeline.d.ts +1 -1
  77. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-selectors.d.ts +1 -1
  78. package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-document-id.d.ts +1 -1
  79. package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-selectors.d.ts +1 -1
  80. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions.d.ts +42 -42
  81. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +44 -44
  82. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +42 -43
  83. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-mappings.d.ts +1 -1
  84. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +44 -44
  85. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-selectors.d.ts +1 -1
  86. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-hub/search-hub-selectors.d.ts +1 -1
  87. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-serializer.d.ts +5 -2
  88. package/force-app/main/default/staticresources/coveoheadless/definitions/selectors/commerce-selectors.index.d.ts +2 -2
  89. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts +4 -3
  90. package/force-app/main/default/staticresources/coveoheadless/definitions/state/commerce-app-state.d.ts +2 -2
  91. package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts +4 -0
  92. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-request.d.ts +44 -44
  93. package/force-app/main/default/staticresources/coveoheadless/definitions/tsdoc-metadata.json +1 -1
  94. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/compare-utils.d.ts +2 -1
  95. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/errors.d.ts +3 -0
  96. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/utils.d.ts +0 -1
  97. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/validate-payload.d.ts +1 -1
  98. package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -12
  99. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -11
  100. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +8 -10
  101. package/force-app/main/default/staticresources/dompurify/purify.min.js +2 -1339
  102. package/force-app/main/default/staticresources/marked/marked.min.js +3 -3
  103. package/package.json +12 -16
@@ -0,0 +1,76 @@
1
+ import {BreadcrumbManagerObject} from './pageObject';
2
+ import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
3
+ import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
4
+ import {
5
+ searchRequestRegex,
6
+ insightSearchRequestRegex,
7
+ } from '../../../../../../playwright/utils/requests';
8
+ import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
9
+ import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
10
+
11
+ const breadcrumbManagerUrl = 's/quantic-breadcrumb-manager';
12
+
13
+ interface BreadcrumbManagerOptions {
14
+ categoryDivider: string;
15
+ collapseThreshold: number;
16
+ }
17
+
18
+ type QuanticBreadcrumbManagerE2EFixtures = {
19
+ breadcrumbManager: BreadcrumbManagerObject;
20
+ search: SearchObject;
21
+ options: Partial<BreadcrumbManagerOptions>;
22
+ };
23
+
24
+ type QuanticBreadcrumbManagerE2ESearchFixtures =
25
+ QuanticBreadcrumbManagerE2EFixtures & {
26
+ urlHash: string;
27
+ };
28
+
29
+ type QuanticBreadcrumbManagerE2eInsightFixtures =
30
+ QuanticBreadcrumbManagerE2ESearchFixtures & {
31
+ insightSetup: InsightSetupObject;
32
+ };
33
+
34
+ export const testSearch =
35
+ quanticBase.extend<QuanticBreadcrumbManagerE2ESearchFixtures>({
36
+ options: {},
37
+ urlHash: '',
38
+ search: async ({page}, use) => {
39
+ await use(new SearchObject(page, searchRequestRegex));
40
+ },
41
+ breadcrumbManager: async (
42
+ {page, options, configuration, search, urlHash},
43
+ use
44
+ ) => {
45
+ await page.goto(
46
+ urlHash ? `${breadcrumbManagerUrl}#${urlHash}` : breadcrumbManagerUrl
47
+ );
48
+ configuration.configure(options);
49
+ await search.waitForSearchResponse();
50
+ await use(new BreadcrumbManagerObject(page));
51
+ },
52
+ });
53
+
54
+ export const testInsight =
55
+ quanticBase.extend<QuanticBreadcrumbManagerE2eInsightFixtures>({
56
+ options: {},
57
+ search: async ({page}, use) => {
58
+ await use(new SearchObject(page, insightSearchRequestRegex));
59
+ },
60
+ insightSetup: async ({page}, use) => {
61
+ await use(new InsightSetupObject(page));
62
+ },
63
+ breadcrumbManager: async (
64
+ {page, options, search, configuration, insightSetup},
65
+ use
66
+ ) => {
67
+ await page.goto(breadcrumbManagerUrl);
68
+ configuration.configure({...options, useCase: useCaseEnum.insight});
69
+ await insightSetup.waitForInsightInterfaceInitialization();
70
+ await search.performSearch();
71
+ await search.waitForSearchResponse();
72
+ await use(new BreadcrumbManagerObject(page));
73
+ },
74
+ });
75
+
76
+ export {expect} from '@playwright/test';
@@ -0,0 +1,282 @@
1
+ import type {Locator, Page, Request} from '@playwright/test';
2
+ import {isUaSearchEvent} from '../../../../../../playwright/utils/requests';
3
+
4
+ const breadcrumbElementsSelectors = {
5
+ regularFacet: {
6
+ component: 'c-quantic-facet',
7
+ facetValueComponent: 'c-quantic-facet-value',
8
+ breadcrumbElementTestId: 'facet-breadcrumb',
9
+ breadcrumbValueElementTestId: 'facet-breadcrumb-value',
10
+ },
11
+ numericFacet: {
12
+ component: 'c-quantic-numeric-facet',
13
+ facetValueComponent: 'c-quantic-facet-value',
14
+ breadcrumbElementTestId: 'numeric-facet-breadcrumb',
15
+ breadcrumbValueElementTestId: 'numeric-facet-breadcrumb-value',
16
+ },
17
+ categoryFacet: {
18
+ component: 'c-quantic-category-facet',
19
+ facetValueComponent: 'c-quantic-category-facet-value',
20
+ breadcrumbElementTestId: 'category-facet-breadcrumb',
21
+ breadcrumbValueElementTestId: 'category-facet-breadcrumb-value',
22
+ },
23
+ timeframeFacet: {
24
+ component: 'c-quantic-timeframe-facet',
25
+ facetValueComponent: 'c-quantic-facet-value',
26
+ breadcrumbElementTestId: 'date-facet-breadcrumb',
27
+ breadcrumbValueElementTestId: 'date-facet-breadcrumb-value',
28
+ },
29
+ };
30
+
31
+ export class BreadcrumbManagerObject {
32
+ constructor(public page: Page) {
33
+ this.page = page;
34
+ }
35
+
36
+ async countAllFacetsBreadcrumb() {
37
+ return (
38
+ (await this.allRegularFacetBreadcrumb.count()) +
39
+ (await this.allNumericFacetBreadcrumb.count()) +
40
+ (await this.allCategoryFacetBreadcrumb.count()) +
41
+ (await this.allTimeframeFacetBreadcrumb.count())
42
+ );
43
+ }
44
+
45
+ /** REGULAR FACET */
46
+ get allRegularFacetBreadcrumb(): Locator {
47
+ return this.page.getByTestId(
48
+ breadcrumbElementsSelectors.regularFacet.breadcrumbElementTestId
49
+ );
50
+ }
51
+
52
+ get firstRegularFacetBreadcrumb(): Locator {
53
+ return this.page
54
+ .getByTestId(
55
+ breadcrumbElementsSelectors.regularFacet.breadcrumbElementTestId
56
+ )
57
+ .first();
58
+ }
59
+
60
+ async clickFirstRegularFacetBreadcrumbValue(): Promise<void> {
61
+ await this.firstRegularFacetBreadcrumb
62
+ .getByTestId(
63
+ breadcrumbElementsSelectors.regularFacet.breadcrumbValueElementTestId
64
+ )
65
+ .click();
66
+ }
67
+
68
+ get firstRegularFacet(): Locator {
69
+ return this.page
70
+ .locator(breadcrumbElementsSelectors.regularFacet.component)
71
+ .first();
72
+ }
73
+
74
+ get firstRegularFacetValue(): Promise<string | null> {
75
+ return this.firstRegularFacet
76
+ .locator(breadcrumbElementsSelectors.regularFacet.facetValueComponent)
77
+ .first()
78
+ .locator('.facet__value-text')
79
+ .textContent();
80
+ }
81
+
82
+ async clickFirstRegularFacetLink(): Promise<void> {
83
+ await this.clickFirstFacetLink(this.firstRegularFacet);
84
+ }
85
+
86
+ async clickFirstFacetLink(facetLocator: Locator): Promise<void> {
87
+ await facetLocator
88
+ .locator(breadcrumbElementsSelectors.regularFacet.facetValueComponent)
89
+ .first()
90
+ .click();
91
+ }
92
+
93
+ /** NUMERIC FACET */
94
+ get allNumericFacetBreadcrumb(): Locator {
95
+ return this.page.getByTestId(
96
+ breadcrumbElementsSelectors.numericFacet.breadcrumbElementTestId
97
+ );
98
+ }
99
+
100
+ get firstNumericFacetBreadcrumb(): Locator {
101
+ return this.page
102
+ .getByTestId(
103
+ breadcrumbElementsSelectors.numericFacet.breadcrumbElementTestId
104
+ )
105
+ .first();
106
+ }
107
+
108
+ async clickFirstNumericFacetBreadcrumbValue(): Promise<void> {
109
+ await this.firstNumericFacetBreadcrumb
110
+ .getByTestId(
111
+ breadcrumbElementsSelectors.numericFacet.breadcrumbValueElementTestId
112
+ )
113
+ .click();
114
+ }
115
+
116
+ get firstNumericFacet(): Locator {
117
+ return this.page
118
+ .locator(breadcrumbElementsSelectors.numericFacet.component)
119
+ .first();
120
+ }
121
+
122
+ get firstNumericFacetValue(): Promise<string | null> {
123
+ return this.firstNumericFacet
124
+ .locator(breadcrumbElementsSelectors.numericFacet.facetValueComponent)
125
+ .first()
126
+ .locator('.facet__value-text')
127
+ .textContent();
128
+ }
129
+
130
+ async clickFirstNumericFacetLink(): Promise<void> {
131
+ await this.clickFirstFacetLink(this.firstNumericFacet);
132
+ }
133
+
134
+ /** DATE|TIMEFRAME FACET */
135
+ get allTimeframeFacetBreadcrumb(): Locator {
136
+ return this.page.getByTestId(
137
+ breadcrumbElementsSelectors.timeframeFacet.breadcrumbElementTestId
138
+ );
139
+ }
140
+
141
+ get firstTimeframeFacetBreadcrumb(): Locator {
142
+ return this.page
143
+ .getByTestId(
144
+ breadcrumbElementsSelectors.timeframeFacet.breadcrumbElementTestId
145
+ )
146
+ .first();
147
+ }
148
+
149
+ async clickFirstTimeframeFacetBreadcrumbValue(): Promise<void> {
150
+ await this.firstTimeframeFacetBreadcrumb
151
+ .getByTestId(
152
+ breadcrumbElementsSelectors.timeframeFacet.breadcrumbValueElementTestId
153
+ )
154
+ .click();
155
+ }
156
+
157
+ get firstTimeframeFacet(): Locator {
158
+ return this.page
159
+ .locator(breadcrumbElementsSelectors.timeframeFacet.component)
160
+ .first();
161
+ }
162
+
163
+ get firstTimeframeFacetValue(): Promise<string | null> {
164
+ return this.firstTimeframeFacet
165
+ .locator(breadcrumbElementsSelectors.timeframeFacet.facetValueComponent)
166
+ .first()
167
+ .locator('.facet__value-text')
168
+ .textContent();
169
+ }
170
+
171
+ async clickFirstTimeframeFacetLink(): Promise<void> {
172
+ await this.clickFirstFacetLink(this.firstTimeframeFacet);
173
+ }
174
+
175
+ /** CATEGORY FACET */
176
+ get allCategoryFacetBreadcrumb(): Locator {
177
+ return this.page.getByTestId(
178
+ breadcrumbElementsSelectors.categoryFacet.breadcrumbElementTestId
179
+ );
180
+ }
181
+
182
+ get firstCategoryFacetBreadcrumb(): Locator {
183
+ return this.page
184
+ .getByTestId(
185
+ breadcrumbElementsSelectors.categoryFacet.breadcrumbElementTestId
186
+ )
187
+ .first();
188
+ }
189
+
190
+ async clickFirstCategoryFacetBreadcrumbValue(): Promise<void> {
191
+ await this.firstCategoryFacetBreadcrumb
192
+ .getByTestId(
193
+ breadcrumbElementsSelectors.categoryFacet.breadcrumbValueElementTestId
194
+ )
195
+ .click();
196
+ }
197
+
198
+ get firstCategoryFacet(): Locator {
199
+ return this.page
200
+ .locator(breadcrumbElementsSelectors.categoryFacet.component)
201
+ .first();
202
+ }
203
+
204
+ get firstCategoryFacetValue(): Promise<string | null> {
205
+ return this.firstCategoryFacet
206
+ .locator(breadcrumbElementsSelectors.categoryFacet.facetValueComponent)
207
+ .first()
208
+ .locator('.facet__value-option')
209
+ .locator('span:not(.facet__number-of-results)')
210
+ .textContent();
211
+ }
212
+
213
+ async clickFirstCategoryFacetLink(): Promise<void> {
214
+ await this.clickFirstCategoryFacetValue(this.firstCategoryFacet);
215
+ }
216
+
217
+ async clickFirstCategoryFacetValue(facetLocator: Locator): Promise<void> {
218
+ await facetLocator
219
+ .locator(breadcrumbElementsSelectors.categoryFacet.facetValueComponent)
220
+ .first()
221
+ .click();
222
+ }
223
+
224
+ get clearAllButton(): Locator {
225
+ return this.page.getByRole('button', {name: /Clear All Filters/i});
226
+ }
227
+
228
+ async clickClearAllButton(): Promise<void> {
229
+ await this.clearAllButton.click();
230
+ }
231
+
232
+ async waitForBreadcrumbSearchUaAnalytics(
233
+ actionCause: string,
234
+ customChecker?: Function
235
+ ): Promise<Request> {
236
+ const uaRequest = this.page.waitForRequest((request) => {
237
+ if (isUaSearchEvent(request)) {
238
+ const requestBody = request.postDataJSON?.();
239
+ const {customData} = requestBody;
240
+
241
+ const expectedFields = {
242
+ actionCause: actionCause,
243
+ };
244
+ const matchesExpectedFields = Object.keys(expectedFields).every(
245
+ (key) => requestBody?.[key] === expectedFields[key]
246
+ );
247
+
248
+ return (
249
+ matchesExpectedFields &&
250
+ (customChecker ? customChecker(customData) : true)
251
+ );
252
+ }
253
+ return false;
254
+ });
255
+ return uaRequest;
256
+ }
257
+
258
+ async waitForBreadcrumbFacetUaAnalytics(
259
+ expectedCustomFields: Record<string, any>
260
+ ): Promise<Request> {
261
+ return this.waitForBreadcrumbSearchUaAnalytics(
262
+ 'breadcrumbFacet',
263
+ (customData: Record<string, any>) => {
264
+ return Object.keys(expectedCustomFields).every((key) =>
265
+ typeof expectedCustomFields[key] === 'object'
266
+ ? JSON.stringify(customData?.[key]) ===
267
+ JSON.stringify(expectedCustomFields[key])
268
+ : customData?.[key] === expectedCustomFields[key]
269
+ );
270
+ }
271
+ );
272
+ }
273
+
274
+ async waitForBreadcrumbResetAllUaAnalytics(
275
+ customChecker?: Function
276
+ ): Promise<Request> {
277
+ return this.waitForBreadcrumbSearchUaAnalytics(
278
+ 'breadcrumbResetAll',
279
+ customChecker
280
+ );
281
+ }
282
+ }
@@ -0,0 +1,167 @@
1
+ import {testSearch, testInsight} from './fixture';
2
+ import {
3
+ useCaseEnum,
4
+ useCaseTestCases,
5
+ } from '../../../../../../playwright/utils/useCase';
6
+
7
+ const fixtures = {
8
+ search: testSearch,
9
+ insight: testInsight,
10
+ };
11
+
12
+ const datetimeFacetLabelToValue = {
13
+ 'Past week': 'past-1-week..now',
14
+ 'Past month': 'past-1-month..now',
15
+ 'Past 6 months': 'past-6-month..now',
16
+ 'Past year': 'past-1-year..now',
17
+ 'Past decade': 'past-10-year..now',
18
+ };
19
+
20
+ useCaseTestCases.forEach((useCase) => {
21
+ let test = fixtures[useCase.value];
22
+
23
+ test.describe(`quantic breadcrumb manager ${useCase.label}`, () => {
24
+ test.describe('when de-selecting a facet value', () => {
25
+ test.describe('with regular facet values', () => {
26
+ test('should trigger a new search and log analytics', async ({
27
+ breadcrumbManager,
28
+ search,
29
+ }) => {
30
+ const firstRegularFacetValue =
31
+ await breadcrumbManager.firstRegularFacetValue;
32
+ const searchResponsePromise = search.waitForSearchResponse();
33
+ await breadcrumbManager.clickFirstRegularFacetLink();
34
+ await searchResponsePromise;
35
+
36
+ const secondSearchResponsePromise = search.waitForSearchResponse();
37
+ const breadcrumbAnalyticsPromise =
38
+ breadcrumbManager.waitForBreadcrumbFacetUaAnalytics({
39
+ facetValue: firstRegularFacetValue,
40
+ });
41
+ await breadcrumbManager.clickFirstRegularFacetBreadcrumbValue();
42
+ await secondSearchResponsePromise;
43
+ await breadcrumbAnalyticsPromise;
44
+ });
45
+ });
46
+
47
+ test.describe('with numeric facet values', () => {
48
+ test('should trigger a new search and log analytics', async ({
49
+ breadcrumbManager,
50
+ search,
51
+ }) => {
52
+ const [facetRangeStart, facetRangeEnd] =
53
+ (await breadcrumbManager.firstNumericFacetValue)?.split(' - ') ??
54
+ [];
55
+ const searchResponsePromise = search.waitForSearchResponse();
56
+ await breadcrumbManager.clickFirstNumericFacetLink();
57
+ await searchResponsePromise;
58
+
59
+ const secondSearchResponsePromise = search.waitForSearchResponse();
60
+ // We use the facet display value to compare, but the display value is localized and can contain non-numeric characters while the analytics request doesn't contain those characters.
61
+ const breadcrumbAnalyticsPromise =
62
+ breadcrumbManager.waitForBreadcrumbFacetUaAnalytics({
63
+ facetRangeStart: facetRangeStart.replace(/[^\d]/g, ''),
64
+ facetRangeEnd: facetRangeEnd.replace(/[^\d]/g, ''),
65
+ });
66
+ await breadcrumbManager.clickFirstNumericFacetBreadcrumbValue();
67
+ await secondSearchResponsePromise;
68
+ await breadcrumbAnalyticsPromise;
69
+ });
70
+ });
71
+
72
+ test.describe('with timeframe|date facet values', () => {
73
+ test('should trigger a new search and log analytics', async ({
74
+ breadcrumbManager,
75
+ search,
76
+ }) => {
77
+ const facetValue = await breadcrumbManager.firstTimeframeFacetValue;
78
+ test.expect(facetValue).not.toBeNull();
79
+ const searchResponsePromise = search.waitForSearchResponse();
80
+ await breadcrumbManager.clickFirstTimeframeFacetLink();
81
+ await searchResponsePromise;
82
+
83
+ const secondSearchResponsePromise = search.waitForSearchResponse();
84
+ // We use the facet display value to compare, but the display value is prettified and is transformed to be human readable, while the analytics request isn't.
85
+ const [expectedFacetRangeStart, expectedFacetRangeEnd] =
86
+ datetimeFacetLabelToValue[facetValue!].split('..');
87
+ const breadcrumbAnalyticsPromise =
88
+ breadcrumbManager.waitForBreadcrumbFacetUaAnalytics({
89
+ facetRangeStart: expectedFacetRangeStart,
90
+ facetRangeEnd: expectedFacetRangeEnd,
91
+ });
92
+ await breadcrumbManager.clickFirstTimeframeFacetBreadcrumbValue();
93
+ await secondSearchResponsePromise;
94
+ await breadcrumbAnalyticsPromise;
95
+ });
96
+ });
97
+
98
+ test.describe('with category facet values', () => {
99
+ test('should trigger a new search and log analytics', async ({
100
+ breadcrumbManager,
101
+ search,
102
+ }) => {
103
+ const facetValue = await breadcrumbManager.firstCategoryFacetValue;
104
+ test.expect(facetValue).not.toBeNull();
105
+ const searchResponsePromise = search.waitForSearchResponse();
106
+ await breadcrumbManager.clickFirstCategoryFacetLink();
107
+ await searchResponsePromise;
108
+
109
+ const secondSearchResponsePromise = search.waitForSearchResponse();
110
+ const expectedFacetValue = facetValue!;
111
+ const breadcrumbAnalyticsPromise =
112
+ breadcrumbManager.waitForBreadcrumbFacetUaAnalytics({
113
+ categoryFacetPath: [expectedFacetValue],
114
+ });
115
+ await breadcrumbManager.clickFirstCategoryFacetBreadcrumbValue();
116
+ await secondSearchResponsePromise;
117
+ await breadcrumbAnalyticsPromise;
118
+ });
119
+ });
120
+ });
121
+
122
+ test.describe('when clicking on the clear all filters button', () => {
123
+ test('should send a clear all filters analytics event and clear all selected facets values', async ({
124
+ breadcrumbManager,
125
+ search,
126
+ }) => {
127
+ const searchResponsePromise = search.waitForSearchResponse();
128
+ await breadcrumbManager.clickFirstRegularFacetLink();
129
+ await searchResponsePromise;
130
+
131
+ const searchResponsePromiseTwo = search.waitForSearchResponse();
132
+ await breadcrumbManager.clickFirstTimeframeFacetLink();
133
+ await searchResponsePromiseTwo;
134
+
135
+ test.expect(breadcrumbManager.clearAllButton).toBeVisible();
136
+ const clearAllSearchResponsePromise = search.waitForSearchResponse();
137
+ const clearAllAnalyticsPromise =
138
+ breadcrumbManager.waitForBreadcrumbResetAllUaAnalytics();
139
+ await breadcrumbManager.clickClearAllButton();
140
+ await clearAllAnalyticsPromise;
141
+ const clearAllSearchResponse = await clearAllSearchResponsePromise;
142
+ const {facets} = await clearAllSearchResponse.json();
143
+ const activeFacets = facets.filter((facet: any) =>
144
+ facet.values.some((value: any) => value.state !== 'idle')
145
+ );
146
+ test.expect(activeFacets).toHaveLength(0);
147
+ });
148
+ });
149
+
150
+ if (useCase.value === useCaseEnum.search) {
151
+ test.describe('when loading with a facet already selected', () => {
152
+ const facetSelectedHash = 'f-filetype=YouTubeVideo';
153
+ test.use({
154
+ urlHash: facetSelectedHash,
155
+ });
156
+
157
+ test('should have a facet selected in the breadcrumb manager', async ({
158
+ breadcrumbManager,
159
+ }) => {
160
+ test
161
+ .expect(await breadcrumbManager.countAllFacetsBreadcrumb())
162
+ .toBe(1);
163
+ });
164
+ });
165
+ }
166
+ });
167
+ });
@@ -9,29 +9,29 @@
9
9
  <div class="slds-col slds-truncate slds-col_bump-right breadcrumb-manager__column">
10
10
  <ul>
11
11
  <template for:each={facetBreadcrumbValues} for:item="breadcrumb">
12
- <li key={breadcrumb.facetId} class="slds-list_horizontal breadcrumb-manager__facet-list breadcrumb-manager__line">
12
+ <li data-testid="facet-breadcrumb" key={breadcrumb.facetId} class="slds-list_horizontal breadcrumb-manager__facet-list breadcrumb-manager__line">
13
13
  <span class="slds-col breadcrumb-manager__field-name">{breadcrumb.label}{labels.colon} </span>
14
14
  <ul class="slds-col slds-truncate slds-list_horizontal slds-grid slds-wrap">
15
15
  <template for:each={breadcrumb.values} for:item="breadcrumbValue">
16
16
  <li key={breadcrumbValue.value.value} class="breadcrumb__container">
17
- <c-quantic-pill label={breadcrumbValue.formattedValue} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumb.label} action-name={labels.clearFilter}></c-quantic-pill>
17
+ <c-quantic-pill data-testid="facet-breadcrumb-value" label={breadcrumbValue.formattedValue} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumb.label} action-name={labels.clearFilter}></c-quantic-pill>
18
18
  </li>
19
19
  </template>
20
20
  <template if:true={breadcrumb.showMoreButton}>
21
21
  <li>
22
- <button onclick={breadcrumb.expandButtonClick} class="slds-grid slds-button slds-var-m-around_xxx-small slds-p-horizontal_x-small slds-p-vertical_xx-small slds-text-color_default breadcrumb-manager__more-button">{breadcrumb.showMoreButtonText}</button>
22
+ <button onclick={breadcrumb.expandButtonClick} data-testid="breadcrumb-manager__more-button" class="slds-grid slds-button slds-var-m-around_xxx-small slds-p-horizontal_x-small slds-p-vertical_xx-small slds-text-color_default breadcrumb-manager__more-button">{breadcrumb.showMoreButtonText}</button>
23
23
  </li>
24
24
  </template>
25
25
  </ul>
26
26
  </li>
27
27
  </template>
28
28
  <template for:each={numericFacetBreadcrumbsValues} for:item="breadcrumb">
29
- <li key={breadcrumb.facetId} class="slds-list_horizontal breadcrumb-manager__numeric-facet-list breadcrumb-manager__line">
29
+ <li data-testid="numeric-facet-breadcrumb" key={breadcrumb.facetId} class="slds-list_horizontal breadcrumb-manager__numeric-facet-list breadcrumb-manager__line">
30
30
  <span class="slds-col breadcrumb-manager__field-name">{breadcrumb.label}{labels.colon} </span>
31
31
  <ul class="slds-col slds-truncate slds-list_horizontal slds-grid slds-wrap">
32
32
  <template for:each={breadcrumb.values} for:item="breadcrumbValue">
33
33
  <li key={breadcrumbValue.value} class="breadcrumb__container">
34
- <c-quantic-pill label={breadcrumbValue.formattedValue} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumb.label} action-name={labels.clearFilter}></c-quantic-pill>
34
+ <c-quantic-pill data-testid="numeric-facet-breadcrumb-value" label={breadcrumbValue.formattedValue} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumb.label} action-name={labels.clearFilter}></c-quantic-pill>
35
35
  </li>
36
36
  </template>
37
37
  <template if:true={breadcrumb.showMoreButton}>
@@ -43,22 +43,22 @@
43
43
  </li>
44
44
  </template>
45
45
  <template for:each={categoryFacetBreadcrumbsValues} for:item="breadcrumbValue">
46
- <li key={breadcrumbValue.facetId} class="slds-list_horizontal breadcrumb-manager__category-facet-list breadcrumb-manager__line">
46
+ <li data-testid="category-facet-breadcrumb" key={breadcrumbValue.facetId} class="slds-list_horizontal breadcrumb-manager__category-facet-list breadcrumb-manager__line">
47
47
  <span class="slds-col breadcrumb-manager__field-name">{breadcrumbValue.label}{labels.colon} </span>
48
48
  <ul class="slds-col slds-truncate slds-list_horizontal slds-grid slds-wrap">
49
49
  <li class="breadcrumb__container">
50
- <c-quantic-pill label={breadcrumbValue.value} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumbValue.label} action-name={labels.clearFilter}></c-quantic-pill>
50
+ <c-quantic-pill data-testid="category-facet-breadcrumb-value" label={breadcrumbValue.value} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumbValue.label} action-name={labels.clearFilter}></c-quantic-pill>
51
51
  </li>
52
52
  </ul>
53
53
  </li>
54
54
  </template>
55
55
  <template for:each={dateFacetBreadcrumbsValues} for:item="breadcrumb">
56
- <li key={breadcrumb.facetId} class="slds-list_horizontal breadcrumb-manager__date-facet-list breadcrumb-manager__line">
56
+ <li data-testid="date-facet-breadcrumb" key={breadcrumb.facetId} class="slds-list_horizontal breadcrumb-manager__date-facet-list breadcrumb-manager__line">
57
57
  <span class="slds-col breadcrumb-manager__field-name">{breadcrumb.label}{labels.colon} </span>
58
58
  <ul class="slds-col slds-truncate slds-list_horizontal slds-grid slds-wrap">
59
59
  <template for:each={breadcrumb.values} for:item="breadcrumbValue">
60
60
  <li key={breadcrumbValue.value} class="breadcrumb__container">
61
- <c-quantic-pill label={breadcrumbValue.value} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumb.label} action-name={labels.clearFilter}></c-quantic-pill>
61
+ <c-quantic-pill data-testid="date-facet-breadcrumb-value" label={breadcrumbValue.value} onquantic__deselect={breadcrumbValue.deselect} group-name={breadcrumb.label} action-name={labels.clearFilter}></c-quantic-pill>
62
62
  </li>
63
63
  </template>
64
64
  <template if:true={breadcrumb.showMoreButton}>
@@ -74,7 +74,7 @@
74
74
  <div class="slds-col breadcrumb-manager__column slds-nowrap breadcrumb-manager__clear-button slds-m-left_small slds-shrink-none">
75
75
  <ul class="slds-m-around_xx-small">
76
76
  <li>
77
- <button class="slds-button slds-var-m-around_xxx-small" onclick={deselectAll}>{labels.clearAllFilters}</button>
77
+ <button class="slds-button slds-var-m-around_xxx-small" data-testid="breadcrumb-manager__clear-button" onclick={deselectAll}>{labels.clearAllFilters}</button>
78
78
  </li>
79
79
  </ul>
80
80
  </div>
@@ -120,18 +120,18 @@ export default class QuanticBreadcrumbManager extends LightningElement {
120
120
  const data = getFromStore(this.engineId, Store.facetTypes.NUMERICFACETS);
121
121
  return {
122
122
  ...breadcrumb,
123
- label: data ? data[breadcrumb.field]?.label : breadcrumb.field,
123
+ label: data ? data[breadcrumb.facetId]?.label : breadcrumb.field,
124
124
  values: breadcrumb.values.map((range) => ({
125
125
  ...range,
126
126
  value: `${range.value.start} - ${range.value.end}`,
127
- formattedValue: data[breadcrumb.field]?.format(range.value),
127
+ formattedValue: data[breadcrumb.facetId]?.format(range.value),
128
128
  })),
129
129
  };
130
130
  }
131
131
 
132
132
  formatCategoryBreadcrumbValue(breadcrumb) {
133
133
  const data = getFromStore(this.engineId, Store.facetTypes.CATEGORYFACETS);
134
- const format = data[breadcrumb.field]?.format ?? ((item) => item.value);
134
+ const format = data[breadcrumb.facetId]?.format ?? ((item) => item.value);
135
135
 
136
136
  if (breadcrumb.path.length <= 3) {
137
137
  return breadcrumb.path.map((breadcrumbValue) => format(breadcrumbValue));
@@ -175,10 +175,10 @@ export default class QuanticBreadcrumbManager extends LightningElement {
175
175
  const data = getFromStore(this.engineId, Store.facetTypes.DATEFACETS);
176
176
  return {
177
177
  ...breadcrumb,
178
- label: data ? data[breadcrumb.field]?.label : breadcrumb.field,
178
+ label: data ? data[breadcrumb.facetId]?.label : breadcrumb.field,
179
179
  values: breadcrumb.values.map((range) => ({
180
180
  ...range,
181
- value: data[breadcrumb.field]?.format(range.value),
181
+ value: data[breadcrumb.facetId]?.format(range.value),
182
182
  })),
183
183
  };
184
184
  }
@@ -187,10 +187,10 @@ export default class QuanticBreadcrumbManager extends LightningElement {
187
187
  const data = getFromStore(this.engineId, Store.facetTypes.FACETS);
188
188
  return {
189
189
  ...breadcrumb,
190
- label: data ? data[breadcrumb.field]?.label : breadcrumb.field,
190
+ label: data ? data[breadcrumb.facetId]?.label : breadcrumb.field,
191
191
  values: breadcrumb.values.map((item) => ({
192
192
  ...item,
193
- formattedValue: data[breadcrumb.field]?.format(item.value),
193
+ formattedValue: data[breadcrumb.facetId]?.format(item.value),
194
194
  })),
195
195
  };
196
196
  }
@@ -266,7 +266,7 @@ export default class QuanticBreadcrumbManager extends LightningElement {
266
266
  return {
267
267
  facetId: breadcrumb.facetId,
268
268
  field: breadcrumb.field,
269
- label: data ? data[breadcrumb.field]?.label : breadcrumb.field,
269
+ label: data ? data[breadcrumb.facetId]?.label : breadcrumb.field,
270
270
  deselect: breadcrumb.deselect,
271
271
  value: breadcrumbValues.join(` ${this.categoryDivider} `),
272
272
  };
@@ -17,6 +17,7 @@
17
17
  <div
18
18
  class="slds-grid slds-grid_align-spread slds-grid_vertical-align-start slds-var-p-bottom_x-small feedback-modal-qna__question"
19
19
  key={question.id}
20
+ data-testid={question.id}
20
21
  >
21
22
  <div class="slds-col slds-var-p-top_x-small">
22
23
  {question.question}