@coveo/quantic 3.44.0 → 3.44.2

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

@@ -1,86 +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: string[];
-  let sortLabelWithValue: {label: string; value: string | null}[];
-  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();
-      sortLabelWithValue = await sort.getSortLabelValue();
-      sortArrOptions = sortLabelWithValue.map(({label}) => label);
-      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}) => {
-        await expect(sort.sortDropDown).toHaveText(sortArrOptions[0]);
-
-        // Selecting the next sort using Enter to open dropdown, the ArrowDown, then ENTER key
-        await sort.focusSortDropDown();
-        await sort.openSortDropdownUsingKeyboardEnter();
-        await sort.selectNextSortOptionUsingKeyboard(sortArrOptions[1]);
-        await expect(sort.sortDropDown).toHaveText(sortArrOptions[1]);
-
-        // Selecting the next sort using Space to open dropdown, the ArrowDown, then ENTER key
-        await sort.focusSortDropDown();
-        await sort.openSortDropdownUsingKeyboardEnter(false);
-        await sort.selectNextSortOptionUsingKeyboard(sortArrOptions[2]);
-        await expect(sort.sortDropDown).toHaveText(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,156 +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;
-const mockBuildInteractiveCitation = jest.fn(
-  (engine, {options}) => options.citation
-);
-const mockEngine = {};
-
-// @ts-ignore
-mockHeadlessLoader.initializeWithHeadless = (element, engineId, initialize) => {
-  if (element instanceof QuanticSourceCitations) {
-    if (!isInitialized) {
-      isInitialized = true;
-      initialize(mockEngine);
-    }
-  }
-};
-
-// @ts-ignore
-mockHeadlessLoader.getHeadlessBundle = () => {
-  return {
-    buildInteractiveCitation: mockBuildInteractiveCitation,
-  };
-};
-
-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 mockAnswerId = 'test-answer-id';
-
-const defaultOptions = {
-  citations: mockCitations,
-  answerId: mockAnswerId,
-};
-
-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]
-        );
-      });
-    });
-
-    it('should call buildInteractiveCitation for each citation with the correct parameters', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(mockBuildInteractiveCitation).toHaveBeenCalledTimes(
-        mockCitations.length
-      );
-      mockCitations.forEach((citation) => {
-        expect(mockBuildInteractiveCitation).toHaveBeenCalledWith(mockEngine, {
-          options: {citation, answerId: mockAnswerId},
-        });
-      });
-    });
-
-    it('should pass the disableCitationAnchoring property to the citation component', 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) => {
-        expect(citationElement.disableCitationAnchoring).toBe(false);
-      });
-    });
-  });
-
-  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,387 +0,0 @@
-/* eslint-disable @lwc/lwc/no-unexpected-wire-adapter-usages */
-/* eslint-disable no-import-assign */
-// @ts-ignore
-import QuanticStandaloneSearchBox from 'c/quanticStandaloneSearchBox';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-import {CurrentPageReference} from 'lightning/navigation';
-import getHeadlessConfiguration from '@salesforce/apex/HeadlessController.getHeadlessConfiguration';
-import {STANDALONE_SEARCH_BOX_STORAGE_KEY} from 'c/quanticUtils';
-import {buildCreateTestComponent, cleanup, flushPromises} from 'c/testUtils';
-
-const selectors = {
-  searchBoxInput: 'c-quantic-search-box-input',
-  searchBox: 'c-quantic-search-box',
-  searchInterface: 'c-quantic-search-interface',
-};
-
-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}
-);
-
-// @ts-ignore
-mockHeadlessLoader.loadDependencies = () =>
-  new Promise((resolve) => {
-    resolve();
-  });
-
-let isInitialized = false;
-
-const exampleEngine = {
-  id: 'engineId',
-};
-
-let updateState;
-let stateMock = {};
-const mockStandaloneSearchBox = {
-  state: stateMock,
-  subscribe: jest.fn((cb) => {
-    updateState = cb;
-    cb();
-    // eslint-disable-next-line no-use-before-define
-    return functionsMocks.unsubscribe;
-  }),
-  updateText: jest.fn(),
-  submit: jest.fn(),
-  showSuggestions: jest.fn(),
-  selectSuggestion: jest.fn(),
-};
-
-const functionsMocks = {
-  buildStandaloneSearchBox: jest.fn(() => mockStandaloneSearchBox),
-  unsubscribe: jest.fn(() => {}),
-};
-
-const defaultOptions = {
-  engineId: exampleEngine.id,
-  placeholder: null,
-  withoutSubmitButton: false,
-  numberOfSuggestions: 7,
-  textarea: false,
-  disableRecentQueries: false,
-  keepFiltersOnSearch: false,
-  redirectUrl: '/global-search/%40uri',
-};
-
-const createTestComponent = buildCreateTestComponent(
-  QuanticStandaloneSearchBox,
-  'c-quantic-standalone-search-box',
-  defaultOptions
-);
-
-function mockSuccessfulHeadlessInitialization() {
-  // @ts-ignore
-  mockHeadlessLoader.initializeWithHeadless = (element, _, initialize) => {
-    if (element instanceof QuanticStandaloneSearchBox && !isInitialized) {
-      isInitialized = true;
-      initialize(exampleEngine);
-    }
-  };
-}
-
-describe('c-quantic-standalone-search-box', () => {
-  beforeEach(() => {
-    // @ts-ignore
-    getHeadlessConfiguration.mockResolvedValue(defaultHeadlessConfiguration);
-    mockSuccessfulHeadlessInitialization();
-
-    // @ts-ignore
-    global.CoveoHeadless = {
-      buildStandaloneSearchBox: functionsMocks.buildStandaloneSearchBox,
-    };
-  });
-
-  afterEach(() => {
-    cleanup();
-    isInitialized = false;
-  });
-
-  describe('with default options', () => {
-    it('should properly pass the options to the the quantic-search-box-input component', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      expect(element).not.toBeNull();
-
-      const quanticSearchInterface = element.shadowRoot.querySelector(
-        selectors.searchInterface
-      );
-      expect(quanticSearchInterface).not.toBeNull();
-
-      const input = quanticSearchInterface.querySelector(
-        selectors.searchBoxInput
-      );
-      expect(input).not.toBeNull();
-      expect(input.withoutSubmitButton).toBe(false);
-      expect(input.textarea).toBe(false);
-      expect(input.placeholder).toBe(null);
-      expect(input.inputValue).toBe('');
-      expect(input.recentQueries).toBeUndefined();
-      expect(input.maxNumberOfSuggestions).toBe(7);
-    });
-  });
-
-  describe('with custom options', () => {
-    it('should properly render the quantic standalone search box component', async () => {
-      const element = createTestComponent({
-        engineId: exampleEngine.id,
-        placeholder: 'place',
-        withoutSubmitButton: true,
-        numberOfSuggestions: 10,
-        keepFiltersOnSearch: true,
-        redirectUrl: '/custom-search/%40uri',
-        searchHub: 'customHub',
-        pipeline: 'customPipeline',
-        textarea: true,
-        disableRecentQueries: true,
-      });
-      await flushPromises();
-      expect(element).not.toBeNull();
-
-      const input = element.shadowRoot.querySelector(selectors.searchBoxInput);
-      expect(input).not.toBeNull();
-      expect(input.withoutSubmitButton).toBe(true);
-      expect(input.textarea).toBe(true);
-      expect(input.placeholder).toBe('place');
-      expect(input.inputValue).toBe('');
-      expect(input.recentQueries).toBeUndefined();
-      expect(input.maxNumberOfSuggestions).toBe(7);
-    });
-  });
-
-  describe('with suggestions', () => {
-    it('should render the standalone searchbox component with suggestions', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      stateMock.suggestions = [
-        {
-          rawValue: 'suggestion1',
-          highlightedValue: 'suggestion1',
-        },
-        {
-          rawValue: 'suggestion2',
-          highlightedValue: 'suggestion2',
-        },
-      ];
-      updateState();
-      await flushPromises();
-
-      const input = element.shadowRoot.querySelector(selectors.searchBoxInput);
-      expect(input.suggestions).toStrictEqual([
-        {
-          key: 0,
-          rawValue: 'suggestion1',
-          value: 'suggestion1',
-        },
-        {
-          key: 1,
-          rawValue: 'suggestion2',
-          value: 'suggestion2',
-        },
-      ]);
-    });
-  });
-
-  describe('with redirect', () => {
-    it('should redirect to the search page when a redirect is triggered', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      stateMock.redirectTo = true;
-      stateMock.value = 'search term';
-      stateMock.analytics = 'analytics babyyyy';
-      updateState();
-      await flushPromises();
-
-      expect(localStorage.getItem(STANDALONE_SEARCH_BOX_STORAGE_KEY)).toBe(
-        JSON.stringify({value: 'search term', analytics: 'analytics babyyyy'})
-      );
-    });
-  });
-
-  describe('controller initialization', () => {
-    it('should subscribe to the headless state changes', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(mockStandaloneSearchBox.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 display the searchbox as a non-standalone component', async () => {
-        const element = createTestComponent();
-
-        // @ts-ignore
-        CurrentPageReference.emit({url: nonStandaloneURL});
-        await flushPromises();
-
-        const searchBox = element.shadowRoot.querySelector(selectors.searchBox);
-        expect(searchBox).not.toBeNull();
-        const quanticSearchInterface = element.shadowRoot.querySelector(
-          selectors.searchInterface
-        );
-        expect(quanticSearchInterface).toBeNull();
-      });
-
-      it('should properly pass the keepFiltersOnSearch property to the quanticSearchBox', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          keepFiltersOnSearch: false,
-        });
-
-        // @ts-ignore
-        CurrentPageReference.emit({url: nonStandaloneURL});
-        await flushPromises();
-
-        const searchBox = element.shadowRoot.querySelector(selectors.searchBox);
-
-        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}),
-          })
-        );
-      });
-    });
-  });
-
-  describe('event handling', () => {
-    describe('quantic__inputvaluechange event', () => {
-      it('should call updateText when input value changes', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const newValue = 'test query';
-        const event = new CustomEvent('quantic__inputvaluechange', {
-          detail: {value: newValue},
-        });
-        const eventSpy = jest.spyOn(event, 'stopPropagation');
-
-        element.dispatchEvent(event);
-        expect(mockStandaloneSearchBox.updateText).toHaveBeenCalledWith(
-          newValue
-        );
-        expect(eventSpy).toHaveBeenCalled();
-      });
-
-      it('should not call updateText when value is the same', async () => {
-        const currentValue = 'current query';
-        mockStandaloneSearchBox.state.value = currentValue;
-
-        const element = createTestComponent();
-        await flushPromises();
-
-        const event = new CustomEvent('quantic__inputvaluechange', {
-          detail: {value: currentValue},
-        });
-
-        element.dispatchEvent(event);
-
-        expect(mockStandaloneSearchBox.updateText).not.toHaveBeenCalled();
-      });
-    });
-
-    describe('quantic__submitsearch event', () => {
-      it('should call submit', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const event = new CustomEvent('quantic__submitsearch');
-        const eventSpy = jest.spyOn(event, 'stopPropagation');
-        element.dispatchEvent(event);
-
-        expect(mockStandaloneSearchBox.submit).toHaveBeenCalledTimes(1);
-        expect(eventSpy).toHaveBeenCalled();
-      });
-    });
-
-    describe('quantic__showsuggestions event', () => {
-      it('should call showSuggestions when suggestions should be shown', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const event = new CustomEvent('quantic__showsuggestions');
-        const eventSpy = jest.spyOn(event, 'stopPropagation');
-        element.dispatchEvent(event);
-
-        expect(mockStandaloneSearchBox.showSuggestions).toHaveBeenCalledTimes(
-          1
-        );
-        expect(eventSpy).toHaveBeenCalled();
-      });
-    });
-
-    describe('quantic__selectsuggestion event', () => {
-      it('should call selectSuggestion with the correct value', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const selectedSuggestion = {value: 'selected suggestion'};
-        const event = new CustomEvent('quantic__selectsuggestion', {
-          detail: {selectedSuggestion},
-        });
-        const eventSpy = jest.spyOn(event, 'stopPropagation');
-        element.dispatchEvent(event);
-
-        expect(mockStandaloneSearchBox.selectSuggestion).toHaveBeenCalledWith(
-          selectedSuggestion.value
-        );
-        expect(eventSpy).toHaveBeenCalled();
-      });
-    });
-  });
-});

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

@@ -1,54 +0,0 @@
-import {StandaloneSearchBoxObject} from './pageObject';
-import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
-import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
-import {
-  querySuggestRegex,
-  searchRequestRegex,
-} from '../../../../../../playwright/utils/requests';
-import {QuerySuggestObject} from '../../../../../../playwright/page-object/querySuggestObject';
-
-const standaloneSearchBoxUrl = 's/quantic-standalone-search-box';
-
-interface StandaloneSearchBoxOptions {
-  placeholder?: string;
-  withoutSubmitButton?: boolean;
-  numberOfSuggestions?: number;
-  redirectUrl?: string;
-  searchHub?: string;
-  pipeline?: string;
-  textarea?: boolean;
-  disableRecentQueries?: boolean;
-  keepFiltersOnSearch?: boolean;
-}
-
-type QuanticStandaloneSearchBoxE2EFixtures = {
-  searchBox: StandaloneSearchBoxObject;
-  search: SearchObject;
-  querySuggest: QuerySuggestObject;
-  options: Partial<StandaloneSearchBoxOptions>;
-  urlHash: string;
-};
-
-export const testStandaloneSearchBox =
-  quanticBase.extend<QuanticStandaloneSearchBoxE2EFixtures>({
-    options: {},
-    urlHash: '',
-    search: async ({page}, use) => {
-      await use(new SearchObject(page, searchRequestRegex));
-    },
-    querySuggest: async ({page}, use) => {
-      await use(new QuerySuggestObject(page, querySuggestRegex));
-    },
-    searchBox: async ({page, options, configuration, urlHash, search}, use) => {
-      await search.mockSearchWithBaseResponse();
-      await page.goto(
-        urlHash
-          ? `${standaloneSearchBoxUrl}#${urlHash}`
-          : standaloneSearchBoxUrl
-      );
-      await configuration.configure(options);
-      await use(new StandaloneSearchBoxObject(page));
-    },
-  });
-
-export {expect} from '@playwright/test';