@coveo/quantic 3.44.0 → 3.44.2

package/force-app/main/default/lwc/quanticCategoryFacet/e2e/data.ts

@@ -1,91 +0,0 @@
-const facetId = 'geographicalhierarchy';
-const field = 'geographicalhierarchy';
-const label = 'Country';
-
-/**
- * Facet response before any value is selected.
- */
-export const initialFacetData = {
-  facetId,
-  field,
-  moreValuesAvailable: true,
-  values: [
-    {
-      value: 'North America',
-      state: 'idle',
-      numberOfResults: 112,
-      children: [],
-      path: ['North America'],
-      isLeafValue: false,
-    },
-    {
-      value: 'Africa',
-      state: 'idle',
-      numberOfResults: 58,
-      children: [],
-      path: ['Africa'],
-      isLeafValue: false,
-    },
-  ],
-  indexScore: 1,
-  label,
-};
-
-const [northAmerica] = initialFacetData.values;
-
-/**
- * Facet response after clicking "Show more".
- */
-export const expandedFacetData = {
-  ...initialFacetData,
-  values: [
-    ...initialFacetData.values,
-    {
-      value: 'South America',
-      state: 'idle',
-      numberOfResults: 112,
-      children: [],
-      path: ['South America'],
-      isLeafValue: false,
-    },
-    {
-      value: 'Asia',
-      state: 'idle',
-      numberOfResults: 58,
-      children: [],
-      path: ['Asia'],
-      isLeafValue: false,
-    },
-  ],
-};
-
-/**
- * Facet response after the first parent value is selected.
- */
-export const selectedFacetData = {
-  ...initialFacetData,
-  values: [
-    {
-      ...northAmerica,
-      state: 'selected',
-      children: [
-        {
-          value: 'Canada',
-          state: 'idle',
-          numberOfResults: 45,
-          children: [],
-          path: ['North America', 'Canada'],
-          isLeafValue: true,
-        },
-        {
-          value: 'United States',
-          state: 'idle',
-          numberOfResults: 67,
-          children: [],
-          path: ['North America', 'United States'],
-          isLeafValue: true,
-        },
-      ],
-    },
-  ],
-};

package/force-app/main/default/lwc/quanticCategoryFacet/e2e/fixture.ts

@@ -1,79 +0,0 @@
-import {CategoryFacetObject} from './pageObject';
-import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
-import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
-import {
-  searchRequestRegex,
-  insightSearchRequestRegex,
-} from '../../../../../../playwright/utils/requests';
-import {BaseFacetObject} from '../../../../../../playwright/page-object/baseFacetObject';
-import {initialFacetData} from './data';
-import {facetBase} from '../../../../../../playwright/fixtures/baseFacetFixture';
-
-const pageUrl = 's/quantic-category-facet';
-
-interface FacetOptions {
-  value?: string;
-  caption?: string;
-  withSearch?: boolean;
-  numberOfValues?: number;
-}
-
-type QuanticFacetE2EFixtures = {
-  facet: CategoryFacetObject;
-  options: Partial<FacetOptions>;
-  insightSetup?: InsightSetupObject;
-};
-
-export const testSearch = facetBase.extend<QuanticFacetE2EFixtures>({
-  options: {},
-  facetResponses: {responses: [[initialFacetData]]},
-  baseFacet: async ({page}, use) => {
-    await use(new BaseFacetObject(page, searchRequestRegex));
-  },
-  facet: async (
-    {page, options, configuration, baseFacet, urlHash, facetResponses},
-    use
-  ) => {
-    // search use case: interface auto-triggers a search on load, hence the mockSearchWithBaseResponse call below
-    await baseFacet.mockSearchWithBaseResponse();
-    await page.goto(
-      `${pageUrl}${options.caption ? '-with-captions' : ''}#${urlHash ? urlHash : ''}`
-    );
-    await baseFacet.mockSearchWithFacetResponseSequence(
-      facetResponses?.responses
-    );
-    configuration.configure(options);
-    await baseFacet.waitForSearchResponse();
-
-    await use(new CategoryFacetObject(page));
-  },
-});
-
-export const testInsight = facetBase.extend<QuanticFacetE2EFixtures>({
-  options: {},
-  facetResponses: {responses: [[initialFacetData]]},
-  baseFacet: async ({page}, use) => {
-    await use(new BaseFacetObject(page, insightSearchRequestRegex));
-  },
-  insightSetup: async ({page}, use) => {
-    await use(new InsightSetupObject(page));
-  },
-  facet: async (
-    {page, options, baseFacet, configuration, insightSetup, facetResponses},
-    use
-  ) => {
-    await page.goto(`${pageUrl}${options.caption ? '-with-captions' : ''}`);
-    await baseFacet.mockSearchWithFacetResponseSequence(
-      facetResponses?.responses
-    );
-    configuration.configure({...options, useCase: useCaseEnum.insight});
-    await insightSetup?.waitForInsightInterfaceInitialization();
-    await Promise.all([
-      baseFacet.waitForSearchResponse(),
-      baseFacet.performSearch(),
-    ]);
-    await use(new CategoryFacetObject(page));
-  },
-});
-
-export {expect} from '@playwright/test';

package/force-app/main/default/lwc/quanticCategoryFacet/e2e/pageObject.ts

@@ -1,55 +0,0 @@
-import type {Locator, Page} from '@playwright/test';
-
-export class CategoryFacetObject {
-  constructor(public page: Page) {
-    this.page = page;
-  }
-
-  get facet(): Locator {
-    return this.page.locator('c-quantic-category-facet');
-  }
-
-  get facetValue(): Locator {
-    return this.facet.locator('c-quantic-category-facet-value');
-  }
-
-  get activeParent(): Locator {
-    return this.facet.getByTestId('facet__active-parent');
-  }
-
-  get allCategoriesButton(): Locator {
-    return this.facet.getByRole('button', {name: /all categories/i});
-  }
-
-  get showMoreFacetValuesButton(): Locator {
-    return this.facet.getByRole('button', {
-      name: /Show more values for the .* facet/i,
-    });
-  }
-
-  get showLessFacetValuesButton(): Locator {
-    return this.facet.getByRole('button', {
-      name: /Show less values for the .* facet/i,
-    });
-  }
-
-  get facetSearchBoxInput(): Locator {
-    return this.facet.getByTestId('facet__searchbox-input').locator('input');
-  }
-
-  get facetBreadcrumb(): Locator {
-    return this.page.getByTestId('category-facet-breadcrumb');
-  }
-
-  facetBreadcrumbValueByIndex(index: number): Locator {
-    return this.facetBreadcrumb.locator('c-quantic-pill').nth(index);
-  }
-
-  async clickOnFacetValue(index: number): Promise<void> {
-    await this.facetValue.nth(index).click();
-  }
-
-  async fillFacetSearchBoxInput(query: string): Promise<void> {
-    await this.facetSearchBoxInput.fill(query);
-  }
-}

package/force-app/main/default/lwc/quanticCategoryFacet/e2e/quanticCategoryFacet.e2e.ts

@@ -1,219 +0,0 @@
-import {testSearch, testInsight, expect} from './fixture';
-import {
-  useCaseEnum,
-  useCaseTestCases,
-} from '../../../../../../playwright/utils/useCase';
-import {expandedFacetData, initialFacetData, selectedFacetData} from './data';
-
-const fixtures = {
-  search: testSearch,
-  insight: testInsight,
-};
-
-useCaseTestCases.forEach((useCase) => {
-  let test = fixtures[useCase.value];
-  test.describe(`quantic category facet ${useCase.label}`, () => {
-    test.describe('when selecting a facet value and clicking the all categories button', () => {
-      const selectedIndex = 0;
-      const {facetId, field, values} = initialFacetData;
-      const selectedValue = values[selectedIndex].value;
-
-      test.use({
-        facetResponses: {
-          responses: [
-            [initialFacetData],
-            [selectedFacetData],
-            [initialFacetData],
-          ],
-        },
-      });
-
-      test('should trigger a new search and log the corresponding UA analytics events', async ({
-        baseFacet,
-        facet,
-        page,
-      }) => {
-        const expectedFacetData = {
-          facetId,
-          facetField: field,
-          facetValue: selectedValue,
-        };
-
-        const facetSelectUaRequest =
-          baseFacet.waitForFacetSelectUaAnalytics(expectedFacetData);
-        const firstSearchResponsePromise = baseFacet.waitForSearchResponse();
-        await facet.clickOnFacetValue(selectedIndex);
-
-        await facetSelectUaRequest;
-        const firstSearchResponse = await firstSearchResponsePromise;
-        const {analytics: analyticsForFacetSelect} =
-          baseFacet.extractDataFromResponse(firstSearchResponse);
-        expect(analyticsForFacetSelect.actionCause).toEqual('facetSelect');
-        if (useCase.value === useCaseEnum.search) {
-          expect(analyticsForFacetSelect.customData).toEqual(
-            expect.objectContaining(expectedFacetData)
-          );
-          const url = page.url();
-          expect(decodeURIComponent(url)).toContain(
-            `cf-${field}=${selectedValue}`
-          );
-        }
-
-        const facetClearAllUaRequest =
-          baseFacet.waitForFacetClearAllUaAnalytics({
-            facetId,
-            facetField: field,
-          });
-        const secondSearchResponsePromise = baseFacet.waitForSearchResponse();
-
-        await facet.allCategoriesButton.click();
-
-        await facetClearAllUaRequest;
-        const secondSearchResponse = await secondSearchResponsePromise;
-        const {analytics: analyticsForFacetDeselect} =
-          baseFacet.extractDataFromResponse(secondSearchResponse);
-        expect(analyticsForFacetDeselect.actionCause).toEqual('facetClearAll');
-      });
-    });
-
-    test.describe('when expanding and collapsing facet values using Show More/Less buttons', () => {
-      test.use({
-        facetResponses: {
-          responses: [[initialFacetData], [expandedFacetData]],
-        },
-        options: {
-          numberOfValues: 2,
-        },
-      });
-
-      test('should fetch additional facet values and send correct UA analytics', async ({
-        baseFacet,
-        facet,
-      }) => {
-        const {facetId, field} = initialFacetData;
-        const uaRequest = baseFacet.waitForShowMoreFacetResultsUaAnalytics({
-          facetId,
-          facetField: field,
-        });
-        const firstSearchResponsePromise = baseFacet.waitForSearchResponse();
-
-        await facet.showMoreFacetValuesButton.click();
-
-        await uaRequest;
-        const firstSearchResponse = await firstSearchResponsePromise;
-        const {analytics: analyticsForShowMore} =
-          baseFacet.extractDataFromResponse(firstSearchResponse);
-        expect(analyticsForShowMore.actionCause).toEqual(
-          'showMoreFacetResults'
-        );
-
-        const showLessUaRequest =
-          baseFacet.waitForShowLessFacetResultsUaAnalytics({
-            facetId,
-            facetField: field,
-          });
-        const secondSearchResponsePromise = baseFacet.waitForSearchResponse();
-
-        await facet.showLessFacetValuesButton.click();
-
-        await showLessUaRequest;
-        const secondSearchResponse = await secondSearchResponsePromise;
-        const {analytics: analyticsForShowLess} =
-          baseFacet.extractDataFromResponse(secondSearchResponse);
-        expect(analyticsForShowLess.actionCause).toEqual(
-          'showLessFacetResults'
-        );
-      });
-    });
-
-    test.describe('when a custom caption is provided', () => {
-      const exampleCaption = 'example caption';
-      const facetValueIndex = 0;
-
-      test.use({
-        facetResponses: {
-          responses: [[initialFacetData], [selectedFacetData]],
-        },
-        options: {
-          caption: exampleCaption,
-          value: initialFacetData.values[facetValueIndex].value,
-        },
-      });
-      test('should display the custom caption instead of the raw facet value', async ({
-        baseFacet,
-        facet,
-      }) => {
-        expect(facet.facetValue.nth(facetValueIndex)).toHaveText(
-          new RegExp(exampleCaption)
-        );
-        const {facetId, field, values} = initialFacetData;
-        const expectedFacetData = {
-          facetId,
-          facetField: field,
-          facetValue: values[facetValueIndex].value,
-        };
-        const uaRequest =
-          baseFacet.waitForFacetSelectUaAnalytics(expectedFacetData);
-        const searchResponsePromise = baseFacet.waitForSearchResponse();
-        await facet.clickOnFacetValue(facetValueIndex);
-        await uaRequest;
-        const searchResponse = await searchResponsePromise;
-        const {analytics} = baseFacet.extractDataFromResponse(searchResponse);
-
-        if (useCase.value === useCaseEnum.search) {
-          expect(analytics.customData).toEqual(
-            expect.objectContaining(expectedFacetData)
-          );
-        }
-        expect(facet.facetBreadcrumbValueByIndex(facetValueIndex)).toHaveText(
-          exampleCaption
-        );
-      });
-    });
-
-    if (useCase.value === useCaseEnum.search) {
-      test.describe('when typing in the facet search box input', () => {
-        test.use({
-          options: {
-            withSearch: true,
-          },
-        });
-
-        test('should fetch facet values according to the query typed', async ({
-          baseFacet,
-          facet,
-        }) => {
-          const {field: expectedField} = initialFacetData;
-          const exampleQuery = 'test';
-          const facetSearchResponsePromise =
-            baseFacet.waitForFacetSearchResponse();
-
-          await facet.fillFacetSearchBoxInput(exampleQuery);
-
-          const facetSearchResponse = await facetSearchResponsePromise;
-          const {field, query} =
-            baseFacet.extractDataFromResponse(facetSearchResponse);
-          expect(field).toEqual(expectedField);
-          expect(query).toContain(exampleQuery);
-        });
-      });
-
-      test.describe('with a selected value in the URL', () => {
-        const selectedIndex = 0;
-        const {field, values} = initialFacetData;
-        test.use({
-          urlHash: `cf-${field}=${values[selectedIndex].value}`,
-          facetResponses: {
-            responses: [],
-          },
-        });
-
-        test('should select the correct facet value', async ({facet}) => {
-          expect(facet.activeParent).toHaveText(
-            new RegExp(values[selectedIndex].value)
-          );
-        });
-      });
-    }
-  });
-});