@coveo/quantic 3.16.0 → 3.16.1-pre.1a6fc4649f

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

@@ -1,91 +0,0 @@
-import {testSearch, testInsight, expect} from './fixture';
-import {
-  useCaseEnum,
-  useCaseTestCases,
-} from '../../../../../../playwright/utils/useCase';
-
-const fixtures = {
-  search: testSearch as typeof testSearch,
-  insight: testInsight as typeof testInsight,
-};
-
-useCaseTestCases.forEach((useCase) => {
-  let test;
-  let sortArrOptions;
-  let sortLabelWithValue;
-  if (useCase.value === useCaseEnum.search) {
-    test = fixtures[useCase.value] as typeof testSearch;
-  } else {
-    test = fixtures[useCase.value] as typeof testInsight;
-  }
-
-  test.describe(`quantic sort ${useCase.label}`, () => {
-    test.beforeEach(async ({sort}) => {
-      await sort.clickSortDropDown();
-      sortArrOptions = await sort.allSortLabelOptions();
-      sortLabelWithValue = await sort.getSortLabelValue();
-      await sort.clickSortDropDown();
-    });
-
-    test.describe(`when changing sort option to 2nd position`, () => {
-      test('should trigger a new search and log analytics', async ({
-        sort,
-        search,
-      }) => {
-        const {label: expectedSortName, value: expectedSortValue} =
-          sortLabelWithValue[1]; // Assuming 0 is the first sort option, 1 should be the 2nd one after that.
-
-        const searchResponsePromise = search.waitForSearchResponse();
-        await sort.clickSortDropDown();
-        await sort.clickSortButton(expectedSortName);
-
-        const searchResponse = await searchResponsePromise;
-        const {sortCriteria} = searchResponse.request().postDataJSON();
-        expect(sortCriteria).toBe(expectedSortValue);
-        await sort.waitForSortUaAnalytics(expectedSortValue);
-      });
-    });
-
-    test.describe('when testing accessibility', () => {
-      test('should be accessible to keyboard', async ({sort, page}) => {
-        let selectedSortLabel = await sort.sortDropDown.textContent();
-        expect(selectedSortLabel).toEqual(sortArrOptions[0]);
-
-        // Selecting the next sort using Enter to open dropdown, the ArrowDown, then ENTER key
-        await sort.focusSortDropDown();
-        await sort.openSortDropdownUsingKeyboardEnter();
-        await page.keyboard.press('ArrowDown');
-        await page.keyboard.press('Enter');
-        selectedSortLabel = await sort.sortDropDown.textContent();
-        expect(selectedSortLabel).toEqual(sortArrOptions[1]);
-
-        // Selecting the next sort using Space to open dropdown, the ArrowDown, then ENTER key
-        await sort.focusSortDropDown();
-        await sort.openSortDropdownUsingKeyboardEnter(false);
-        await page.keyboard.press('ArrowDown');
-        await page.keyboard.press('Enter');
-        selectedSortLabel = await sort.sortDropDown.textContent();
-        expect(selectedSortLabel).toEqual(sortArrOptions[2]);
-      });
-    });
-
-    if (useCase.value === 'search') {
-      test.describe('when loading options from the url', () => {
-        test('should reflect the options of url in the component', async ({
-          sort,
-          page,
-        }) => {
-          const {label: expectedSortName, value: expectedSortValue} =
-            sortLabelWithValue[2]; // Assuming 0 is the first sort option
-
-          const currentUrl = await page.url();
-          const urlHash = `#sortCriteria=${encodeURI(expectedSortValue)}`;
-
-          await page.goto(`${currentUrl}/${urlHash}`);
-          await page.getByRole('button', {name: 'Try it now'}).click();
-          await expect(sort.sortDropDown).toContainText(expectedSortName);
-        });
-      });
-    }
-  });
-});

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

@@ -1,123 +0,0 @@
-/* eslint-disable no-import-assign */
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticSourceCitations from '../quanticSourceCitations';
-
-jest.mock('c/quanticHeadlessLoader');
-
-let isInitialized = false;
-
-// @ts-ignore
-mockHeadlessLoader.initializeWithHeadless = (element, engineId, initialize) => {
-  if (element instanceof QuanticSourceCitations) {
-    if (!isInitialized) {
-      isInitialized = true;
-      initialize();
-    }
-  }
-};
-
-// @ts-ignore
-mockHeadlessLoader.getHeadlessBundle = () => {
-  return {
-    buildInteractiveCitation: jest.fn((engine, {options}) => options.citation),
-  };
-};
-
-const mockCitations = [
-  {
-    id: '1',
-    title: 'Example title 1',
-    uri: 'https://example.com/',
-    clickUri: 'https://example.com/',
-    permanentid: '1',
-    text: 'text 01',
-  },
-  {
-    id: '2',
-    title: 'Example title 2',
-    uri: 'https://example.com/',
-    clickUri: 'https://example.com/',
-    permanentid: '2',
-    text: 'text 02',
-  },
-];
-
-const defaultOptions = {
-  citations: mockCitations,
-};
-
-const selectors = {
-  citation: 'c-quantic-citation',
-};
-
-function createTestComponent(options = defaultOptions) {
-  const element = createElement('c-quantic-source-citations', {
-    is: QuanticSourceCitations,
-  });
-
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-
-  document.body.appendChild(element);
-  return element;
-}
-
-// Helper function to wait until the microtask queue is empty.
-function flushPromises() {
-  return new Promise((resolve) => setTimeout(resolve, 0));
-}
-
-describe('c-quantic-source-citations', () => {
-  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);
-    }
-    isInitialized = false;
-    jest.clearAllMocks();
-  }
-
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('when there are citations found', () => {
-    it('should properly display the citations', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      const citations = element.shadowRoot.querySelectorAll(selectors.citation);
-      expect(citations).not.toBeNull();
-      expect(citations.length).toEqual(mockCitations.length);
-
-      citations.forEach((citationElement, index) => {
-        expect(citationElement.citation).toEqual({
-          ...mockCitations[index],
-          index: index + 1,
-        });
-        expect(citationElement.interactiveCitation).toEqual(
-          mockCitations[index]
-        );
-      });
-    });
-  });
-
-  describe('when there are no citations found', () => {
-    it('should not display citations', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        citations: null,
-      });
-      await flushPromises();
-
-      const citations = element.shadowRoot.querySelector(
-        selectors.sourceCitation
-      );
-
-      expect(citations).toBeNull();
-    });
-  });
-});

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

@@ -1,186 +0,0 @@
-/* eslint-disable no-import-assign */
-import QuanticStandaloneSearchBox from 'c/quanticStandaloneSearchBox';
-// @ts-ignore
-import {createElement} from 'lwc';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-import {CurrentPageReference} from 'lightning/navigation';
-import getHeadlessConfiguration from '@salesforce/apex/HeadlessController.getHeadlessConfiguration';
-
-const nonStandaloneURL = 'https://www.example.com/global-search/%40uri';
-const defaultHeadlessConfiguration = JSON.stringify({
-  organization: 'testOrgId',
-  accessToken: 'testAccessToken',
-});
-
-jest.mock('c/quanticHeadlessLoader');
-
-jest.mock(
-  '@salesforce/apex/HeadlessController.getHeadlessConfiguration',
-  () => ({
-    default: jest.fn(),
-  }),
-  {virtual: true}
-);
-
-mockHeadlessLoader.loadDependencies = () =>
-  new Promise((resolve) => {
-    resolve();
-  });
-
-let isInitialized = false;
-
-const exampleEngine = {
-  id: 'engineId',
-};
-
-const functionsMocks = {
-  buildStandaloneSearchBox: jest.fn(() => ({
-    state: {},
-    subscribe: functionsMocks.subscribe,
-  })),
-  subscribe: 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,
-  redirectUrl: '/global-search/%40uri',
-};
-
-function createTestComponent(options = defaultOptions) {
-  prepareHeadlessState();
-  const element = createElement('c-quantic-standalone-search-box', {
-    is: QuanticStandaloneSearchBox,
-  });
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-  document.body.appendChild(element);
-  return element;
-}
-
-function prepareHeadlessState() {
-  // @ts-ignore
-  global.CoveoHeadless = {
-    buildStandaloneSearchBox: functionsMocks.buildStandaloneSearchBox,
-  };
-}
-
-// 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 QuanticStandaloneSearchBox && !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-standalone-search-box', () => {
-  beforeEach(() => {
-    getHeadlessConfiguration.mockResolvedValue(defaultHeadlessConfiguration);
-    mockSuccessfulHeadlessInitialization();
-  });
-
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('controller initialization', () => {
-    it('should subscribe to the headless state changes', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.subscribe).toHaveBeenCalledTimes(1);
-    });
-
-    describe('when the current page reference changes', () => {
-      beforeAll(() => {
-        // This is needed to mock the window.location.href property to test the keepFiltersOnSearch property in the quanticSearchBox.
-        // https://stackoverflow.com/questions/54021037/how-to-mock-window-location-href-with-jest-vuejs
-        Object.defineProperty(window, 'location', {
-          writable: true,
-          value: {href: nonStandaloneURL},
-        });
-      });
-
-      it('should properly pass the keepFiltersOnSearch property to the quanticSearchBox', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          keepFiltersOnSearch: false,
-        });
-        // eslint-disable-next-line @lwc/lwc/no-unexpected-wire-adapter-usages
-        CurrentPageReference.emit({url: nonStandaloneURL});
-        await flushPromises();
-
-        const searchBox = element.shadowRoot.querySelector(
-          'c-quantic-search-box'
-        );
-
-        expect(searchBox).not.toBeNull();
-        expect(searchBox.keepFiltersOnSearch).toEqual(false);
-      });
-    });
-
-    describe('when keepFiltersOnSearch is false (default)', () => {
-      it('should properly initialize the controller with clear filters enabled', async () => {
-        createTestComponent();
-        await flushPromises();
-
-        expect(functionsMocks.buildStandaloneSearchBox).toHaveBeenCalledTimes(
-          1
-        );
-        expect(functionsMocks.buildStandaloneSearchBox).toHaveBeenCalledWith(
-          exampleEngine,
-          expect.objectContaining({
-            options: expect.objectContaining({clearFilters: true}),
-          })
-        );
-      });
-    });
-
-    describe('when keepFiltersOnSearch is true', () => {
-      it('should properly initialize the controller with clear filters disabled', async () => {
-        createTestComponent({
-          ...defaultOptions,
-          keepFiltersOnSearch: true,
-        });
-        await flushPromises();
-
-        expect(functionsMocks.buildStandaloneSearchBox).toHaveBeenCalledTimes(
-          1
-        );
-        expect(functionsMocks.buildStandaloneSearchBox).toHaveBeenCalledWith(
-          exampleEngine,
-          expect.objectContaining({
-            options: expect.objectContaining({clearFilters: false}),
-          })
-        );
-      });
-    });
-  });
-});

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

@@ -1,222 +0,0 @@
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticStatefulButton from '../quanticStatefulButton';
-
-const functionsMocks = {
-  exampleHandleSelect: jest.fn(),
-  exampleHandleDeselect: jest.fn(),
-};
-
-const exampleLabel = 'Example label';
-const exampleIcon = 'utility:clear';
-const exampleTooltip = 'Example tooltip';
-
-const selectors = {
-  statefulButton: '.stateful-button',
-  icon: '.stateful-button__container lightning-icon',
-  tooltip: '.stateful-button__container > c-quantic-tooltip',
-  tooltipContent:
-    '.stateful-button__container > c-quantic-tooltip > div[slot="content"]',
-};
-
-function setupEventListeners(element) {
-  element.addEventListener(
-    'quantic__select',
-    functionsMocks.exampleHandleSelect
-  );
-  element.addEventListener(
-    'quantic__deselect',
-    functionsMocks.exampleHandleDeselect
-  );
-}
-
-const exampleOptions = {
-  label: exampleLabel,
-  iconName: exampleIcon,
-  tooltip: exampleTooltip,
-  selected: false,
-};
-
-function createTestComponent(options = exampleOptions) {
-  const element = createElement('c-quantic-stateful-button', {
-    is: QuanticStatefulButton,
-  });
-
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-
-  document.body.appendChild(element);
-  return element;
-}
-
-// 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));
-}
-
-describe('c-quantic-stateful-button', () => {
-  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();
-  }
-
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('when the stateful button is in the selected state', () => {
-    it('should properly display the selected stateful button', async () => {
-      const element = createTestComponent({...exampleOptions, selected: true});
-      await flushPromises();
-
-      const button = element.shadowRoot.querySelector(selectors.statefulButton);
-      const icon = element.shadowRoot.querySelector(selectors.icon);
-      const tooltip = element.shadowRoot.querySelector(selectors.tooltip);
-      const tooltipContent = element.shadowRoot.querySelector(
-        selectors.tooltipContent
-      );
-
-      expect(button).not.toBeNull();
-      expect(icon).not.toBeNull();
-      expect(tooltip).not.toBeNull();
-      expect(tooltipContent).not.toBeNull();
-      expect(button.ariaLabel).toBe(exampleTooltip);
-      expect(button.textContent).toBe(exampleLabel);
-      expect(icon.iconName).toBe(exampleIcon);
-      expect(button.classList.contains('stateful-button--selected')).toBe(true);
-      expect(button.classList.contains('stateful-button--unselected')).toBe(
-        false
-      );
-      expect(
-        button.classList.contains('stateful-button--without-borders')
-      ).toBe(false);
-      expect(tooltipContent.textContent).toBe(exampleTooltip);
-    });
-
-    describe('when the selected stateful button is clicked', () => {
-      it('should dispatch the "unselect" event', async () => {
-        const element = createTestComponent({
-          ...exampleOptions,
-          selected: true,
-        });
-        setupEventListeners(element);
-        await flushPromises();
-
-        const button = element.shadowRoot.querySelector(
-          selectors.statefulButton
-        );
-        await button.click();
-
-        expect(functionsMocks.exampleHandleDeselect).toHaveBeenCalledTimes(1);
-      });
-    });
-
-    describe('when the withoutBorders property is set to true', () => {
-      it('should display the button without border', async () => {
-        const element = createTestComponent({
-          ...exampleOptions,
-          selected: true,
-          withoutBorders: true,
-        });
-        setupEventListeners(element);
-        await flushPromises();
-
-        const button = element.shadowRoot.querySelector(
-          selectors.statefulButton
-        );
-
-        expect(
-          button.classList.contains('stateful-button--without-borders')
-        ).toBe(true);
-      });
-    });
-
-    describe('when a vlue of the selectedStateColor property is provided', () => {
-      it('should display the button with the correct colors', async () => {
-        const exampleColor = '#FFF';
-        const element = createTestComponent({
-          ...exampleOptions,
-          selectedStateColor: exampleColor,
-        });
-        setupEventListeners(element);
-        await flushPromises();
-
-        expect(element.shadowRoot.host?.style?._values).toEqual({
-          '--selected-state-color': exampleColor,
-        });
-      });
-    });
-  });
-
-  describe('when the stateful button is in the unselected state', () => {
-    it('should properly display the unselected stateful button', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      const button = element.shadowRoot.querySelector(selectors.statefulButton);
-      const icon = element.shadowRoot.querySelector(selectors.icon);
-      const tooltip = element.shadowRoot.querySelector(selectors.tooltip);
-      const tooltipContent = element.shadowRoot.querySelector(
-        selectors.tooltipContent
-      );
-
-      expect(button).not.toBeNull();
-      expect(icon).not.toBeNull();
-      expect(tooltip).not.toBeNull();
-      expect(tooltipContent).not.toBeNull();
-      expect(button.ariaLabel).toBe(exampleTooltip);
-      expect(button.textContent).toBe(exampleLabel);
-      expect(icon.iconName).toBe(exampleIcon);
-      expect(button.classList.contains('stateful-button--selected')).toBe(
-        false
-      );
-      expect(button.classList.contains('stateful-button--unselected')).toBe(
-        true
-      );
-      expect(
-        button.classList.contains('stateful-button--without-borders')
-      ).toBe(false);
-      expect(tooltipContent.textContent).toBe(exampleTooltip);
-    });
-
-    describe('when the unselected stateful button is clicked', () => {
-      it('should dispatch the "select" event', async () => {
-        const element = createTestComponent();
-        setupEventListeners(element);
-        await flushPromises();
-
-        const button = element.shadowRoot.querySelector(
-          selectors.statefulButton
-        );
-        await button.click();
-
-        expect(functionsMocks.exampleHandleSelect).toHaveBeenCalledTimes(1);
-      });
-    });
-
-    describe('when the withoutBorders property is set to true', () => {
-      it('should display the button without border', async () => {
-        const element = createTestComponent({
-          ...exampleOptions,
-          selected: true,
-          withoutBorders: true,
-        });
-        setupEventListeners(element);
-        await flushPromises();
-
-        const button = element.shadowRoot.querySelector(
-          selectors.statefulButton
-        );
-
-        expect(
-          button.classList.contains('stateful-button--without-borders')
-        ).toBe(true);
-      });
-    });
-  });
-});