@coveo/quantic 3.16.0 → 3.16.1-pre.9c01cf606f

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

@@ -1,85 +0,0 @@
-import type {Locator, Page, Request} from '@playwright/test';
-import {isUaCustomEvent} from '../../../../../../playwright/utils/requests';
-
-const resultsPerPageElementsSelectors = {
-  component: 'c-quantic-results-per-page',
-  componentError: 'c-quantic-component-error',
-  resultsPerPageTestId: 'results-per-page',
-  resultsPerPageOptionButton: 'c-quantic-number-button',
-  selectedResultsPerPageOptionButton: 'button.slds-button_brand',
-};
-
-export class ResultsPerPageObject {
-  constructor(public page: Page) {
-    this.page = page;
-  }
-
-  get component(): Locator {
-    return this.page.getByTestId(
-      resultsPerPageElementsSelectors.resultsPerPageTestId
-    );
-  }
-
-  get allResultsPerPageOptionsButtons(): Locator {
-    return this.component.locator(
-      resultsPerPageElementsSelectors.resultsPerPageOptionButton
-    );
-  }
-
-  get selectedResultsPerPageOption(): Locator {
-    return this.allResultsPerPageOptionsButtons.filter({
-      has: this.page.locator(
-        resultsPerPageElementsSelectors.selectedResultsPerPageOptionButton
-      ),
-    });
-  }
-
-  getResultPerPageOptionByValue(value: number): Locator {
-    return this.allResultsPerPageOptionsButtons.getByText(value.toString());
-  }
-
-  async clickResultsPerPageOptionByValue(value: number): Promise<void> {
-    await this.getResultPerPageOptionByValue(value).click();
-  }
-
-  async waitForResultsPerPageClickUA(
-    customChecker?: Function
-  ): Promise<Request> {
-    const uaRequest = this.page.waitForRequest((request) => {
-      if (isUaCustomEvent(request)) {
-        const requestBody = request.postDataJSON?.();
-        const {customData} = requestBody;
-
-        const expectedFields = {
-          eventType: 'getMoreResults',
-          eventValue: 'pagerResize',
-        };
-        const matchesExpectedFields = Object.keys(expectedFields).every(
-          (key) => requestBody?.[key] === expectedFields[key]
-        );
-
-        return (
-          matchesExpectedFields &&
-          (customChecker ? customChecker(customData) : true)
-        );
-      }
-      return false;
-    });
-    return uaRequest;
-  }
-
-  async waitForResultsPerPageUA(
-    expectedCustomFields: Record<string, any>
-  ): Promise<Request> {
-    return this.waitForResultsPerPageClickUA(
-      (customData: Record<string, any>) => {
-        return Object.keys(expectedCustomFields).every((key) =>
-          typeof expectedCustomFields[key] === 'object'
-            ? JSON.stringify(customData?.[key]) ===
-              JSON.stringify(expectedCustomFields[key])
-            : customData?.[key] === expectedCustomFields[key]
-        );
-      }
-    );
-  }
-}

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

@@ -1,97 +0,0 @@
-import {testSearch, testInsight} from './fixture';
-import {
-  useCaseEnum,
-  useCaseTestCases,
-} from '../../../../../../playwright/utils/useCase';
-
-const fixtures = {
-  search: testSearch,
-  insight: testInsight,
-};
-
-const defaultChoices = [10, 25, 50, 100];
-const defaultInitialChoice = 10;
-
-useCaseTestCases.forEach((useCase) => {
-  let test = fixtures[useCase.value];
-
-  test.describe(`quantic results per page ${useCase.label}`, () => {
-    test.describe('with default options', () => {
-      test('should load as expected', async ({resultsPerPage}) => {
-        await test.expect(resultsPerPage.component).toBeVisible();
-        test
-          .expect(await resultsPerPage.allResultsPerPageOptionsButtons.count())
-          .toBe(defaultChoices.length);
-        test
-          .expect(resultsPerPage.selectedResultsPerPageOption)
-          .toHaveText(defaultInitialChoice.toString());
-      });
-
-      test.describe('when selecting a new results per page option', () => {
-        test('should trigger a new search and log analytics', async ({
-          resultsPerPage,
-          search,
-        }) => {
-          const newChoice = 25;
-
-          const searchResponsePromise = search.waitForSearchResponse();
-          const resultsPerPageAnalyticsPromise =
-            resultsPerPage.waitForResultsPerPageUA({
-              currentResultsPerPage: newChoice,
-            });
-
-          await resultsPerPage.clickResultsPerPageOptionByValue(newChoice);
-
-          const searchResponse = await searchResponsePromise;
-          await resultsPerPageAnalyticsPromise;
-
-          test
-            .expect(resultsPerPage.selectedResultsPerPageOption)
-            .toHaveText(newChoice.toString());
-          test
-            .expect(searchResponse.request().postDataJSON()?.numberOfResults)
-            .toBe(newChoice);
-        });
-      });
-    });
-
-    test.describe('with custom options', () => {
-      const customChoices = [20, 40, 80];
-      test.use({
-        options: {
-          choicesDisplayed: customChoices.join(','),
-        },
-      });
-
-      test('should load as expected', async ({resultsPerPage}) => {
-        await test.expect(resultsPerPage.component).toBeVisible();
-        test
-          .expect(await resultsPerPage.allResultsPerPageOptionsButtons.count())
-          .toBe(customChoices.length);
-      });
-    });
-
-    if (useCase.value === useCaseEnum.search) {
-      test.describe('when loading from URL hash', () => {
-        const expectedResultsPerPage = 50;
-        test.use({
-          urlHash: `numberOfResults=${expectedResultsPerPage}`,
-        });
-
-        test('should load the right number of results per page', async ({
-          resultsPerPage,
-        }) => {
-          await test.expect(resultsPerPage.component).toBeVisible();
-          test
-            .expect(
-              await resultsPerPage.allResultsPerPageOptionsButtons.count()
-            )
-            .toBe(defaultChoices.length);
-          test
-            .expect(resultsPerPage.selectedResultsPerPageOption)
-            .toHaveText(expectedResultsPerPage.toString());
-        });
-      });
-    }
-  });
-});

package/force-app/main/default/lwc/quanticSearchBox/__tests__/quanticSearchBox.test.js

@@ -1,168 +0,0 @@
-/* eslint-disable no-import-assign */
-import QuanticSearchBox from 'c/quanticSearchBox';
-// @ts-ignore
-import {createElement} from 'lwc';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-
-jest.mock('c/quanticHeadlessLoader');
-
-let isInitialized = false;
-
-const exampleEngine = {
-  id: 'dummy engine',
-};
-
-const functionsMocks = {
-  buildSearchBox: jest.fn(() => ({
-    state: {},
-    subscribe: functionsMocks.searchBoxSubscriber,
-  })),
-  buildRecentQueriesList: jest.fn(() => ({
-    state: {},
-    subscribe: functionsMocks.recentQueriesSubscriber,
-  })),
-
-  loadQuerySuggestActions: jest.fn(() => {}),
-  searchBoxSubscriber: jest.fn((cb) => {
-    cb();
-    return functionsMocks.unsubscribe;
-  }),
-  recentQueriesSubscriber: jest.fn((cb) => {
-    cb();
-    return functionsMocks.unsubscribe;
-  }),
-  unsubscribe: jest.fn(() => {}),
-};
-
-const defaultOptions = {
-  engineId: exampleEngine.id,
-  placeholder: null,
-  withoutSubmitButton: false,
-  numberOfSuggestions: 7,
-  textarea: false,
-  disableRecentQueries: false,
-  keepFiltersOnSearch: false,
-};
-
-function createTestComponent(options = defaultOptions) {
-  prepareHeadlessState();
-
-  const element = createElement('c-quantic-search-box', {
-    is: QuanticSearchBox,
-  });
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-  document.body.appendChild(element);
-  return element;
-}
-
-function prepareHeadlessState() {
-  // @ts-ignore
-  mockHeadlessLoader.getHeadlessBundle = () => {
-    return {
-      buildSearchBox: functionsMocks.buildSearchBox,
-      buildRecentQueriesList: functionsMocks.buildRecentQueriesList,
-      loadQuerySuggestActions: functionsMocks.loadQuerySuggestActions,
-    };
-  };
-}
-
-// Helper function to wait until the microtask queue is empty.
-function flushPromises() {
-  // eslint-disable-next-line @lwc/lwc/no-async-operation
-  return new Promise((resolve) => setTimeout(resolve, 0));
-}
-
-function mockSuccessfulHeadlessInitialization() {
-  // @ts-ignore
-  mockHeadlessLoader.initializeWithHeadless = (element, _, initialize) => {
-    if (element instanceof QuanticSearchBox && !isInitialized) {
-      isInitialized = true;
-      initialize(exampleEngine);
-    }
-  };
-}
-
-function cleanup() {
-  // The jsdom instance is shared across test cases in a single file so reset the DOM
-  while (document.body.firstChild) {
-    document.body.removeChild(document.body.firstChild);
-  }
-  jest.clearAllMocks();
-  isInitialized = false;
-}
-
-describe('c-quantic-search-box', () => {
-  beforeAll(() => {
-    mockSuccessfulHeadlessInitialization();
-  });
-
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('controller initialization', () => {
-    it('should subscribe to the headless search box state changes', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.searchBoxSubscriber).toHaveBeenCalledTimes(1);
-    });
-
-    it('should subscribe to the headless recent queries state changes', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.recentQueriesSubscriber).toHaveBeenCalledTimes(1);
-    });
-
-    it('should properly initialize the recent queries controller with the right maxLength value', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.buildRecentQueriesList).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildRecentQueriesList).toHaveBeenCalledWith(
-        exampleEngine,
-        expect.objectContaining({
-          options: expect.objectContaining({
-            maxLength: 20,
-          }),
-        })
-      );
-    });
-
-    describe('when keepFiltersOnSearch is false (default)', () => {
-      it('should properly initialize the search box controller with clear filters enabled', async () => {
-        createTestComponent();
-        await flushPromises();
-
-        expect(functionsMocks.buildSearchBox).toHaveBeenCalledTimes(1);
-        expect(functionsMocks.buildSearchBox).toHaveBeenCalledWith(
-          exampleEngine,
-          expect.objectContaining({
-            options: expect.objectContaining({clearFilters: true}),
-          })
-        );
-      });
-    });
-
-    describe('when keepFiltersOnSearch is true', () => {
-      it('should properly initialize the search box controller with clear filters disabled', async () => {
-        createTestComponent({
-          ...defaultOptions,
-          keepFiltersOnSearch: true,
-        });
-        await flushPromises();
-
-        expect(functionsMocks.buildSearchBox).toHaveBeenCalledTimes(1);
-        expect(functionsMocks.buildSearchBox).toHaveBeenCalledWith(
-          exampleEngine,
-          expect.objectContaining({
-            options: expect.objectContaining({clearFilters: false}),
-          })
-        );
-      });
-    });
-  });
-});