@coveo/quantic 3.16.0 → 3.16.1-pre.17ed3a22d0

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

@@ -1,327 +0,0 @@
-/* eslint-disable no-import-assign */
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticCategoryFacet from 'c/quanticCategoryFacet';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-import {generateFacetDependencyConditions} from 'c/quanticUtils';
-
-jest.mock('c/quanticUtils', () => ({
-  generateFacetDependencyConditions: jest.fn(),
-  Store: {
-    facetTypes: {
-      FACETS: 'facets',
-      NUMERICFACETS: 'numericFacets',
-      DATEFACETS: 'dateFacets',
-      CATEGORYFACETS: 'categoryFacets',
-    },
-  },
-  I18nUtils: {
-    format: jest.fn(),
-  },
-}));
-jest.mock('c/quanticHeadlessLoader');
-
-const selectors = {
-  facetContent: '[data-test="facet-content"]',
-  componentError: 'c-quantic-component-error',
-};
-
-const exampleFacetId = 'example facet id';
-const exampleField = 'exampleField';
-const defaultOptions = {
-  field: exampleField,
-};
-const categoryFacetControllerMock = {
-  subscribe: jest.fn((callback) => callback()),
-  state: {
-    facetId: exampleFacetId,
-    values: [],
-  },
-};
-const parentFacetIdError = `The ${exampleField} c-quantic-category-facet requires dependsOn.parentFacetId to be a valid string.`;
-const expectedValueError = `The ${exampleField} c-quantic-category-facet requires dependsOn.expectedValue to be a valid string.`;
-
-function createTestComponent(options = defaultOptions) {
-  prepareHeadlessState();
-
-  const element = createElement('c-quantic-category-facet', {
-    is: QuanticCategoryFacet,
-  });
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-
-  document.body.appendChild(element);
-  return element;
-}
-
-const functionsMocks = {
-  buildCategoryFacet: jest.fn(() => categoryFacetControllerMock),
-  stopWatching: jest.fn(),
-  buildFacetConditionsManager: jest.fn(() => ({
-    stopWatching: functionsMocks.stopWatching,
-  })),
-  buildSearchStatus: jest.fn(() => ({
-    subscribe: jest.fn((callback) => callback()),
-    state: {},
-  })),
-};
-
-function prepareHeadlessState() {
-  // @ts-ignore
-  mockHeadlessLoader.getHeadlessBundle = () => {
-    return {
-      buildCategoryFacet: functionsMocks.buildCategoryFacet,
-      buildSearchStatus: functionsMocks.buildSearchStatus,
-      buildFacetConditionsManager: functionsMocks.buildFacetConditionsManager,
-    };
-  };
-}
-
-// 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));
-}
-
-const exampleEngine = {
-  id: 'dummy engine',
-};
-let isInitialized = false;
-
-function mockBueno() {
-  // @ts-ignore
-  mockHeadlessLoader.getBueno = () => {
-    // @ts-ignore
-    global.Bueno = {
-      isString: jest
-        .fn()
-        .mockImplementation(
-          (value) => Object.prototype.toString.call(value) === '[object String]'
-        ),
-    };
-    return new Promise((resolve) => resolve());
-  };
-}
-
-function mockSuccessfulHeadlessInitialization() {
-  // @ts-ignore
-  mockHeadlessLoader.initializeWithHeadless = (element, _, initialize) => {
-    if (element instanceof QuanticCategoryFacet && !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-category-facet', () => {
-  beforeAll(() => {
-    mockSuccessfulHeadlessInitialization();
-    mockBueno();
-  });
-
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('the facet conditions manager', () => {
-    it('should build the controller when the dependsOn property is set', async () => {
-      const exampleFacetDependency = {
-        parentFacetId: 'filetype',
-        expectedValue: 'txt',
-      };
-      createTestComponent({
-        ...defaultOptions,
-        dependsOn: exampleFacetDependency,
-      });
-      await flushPromises();
-
-      expect(functionsMocks.buildCategoryFacet).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        1
-      );
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledWith(
-        exampleEngine,
-        {
-          facetId: exampleFacetId,
-        }
-      );
-
-      expect(generateFacetDependencyConditions).toHaveBeenCalledTimes(1);
-      expect(generateFacetDependencyConditions).toHaveBeenCalledWith({
-        [exampleFacetDependency.parentFacetId]:
-          exampleFacetDependency.expectedValue,
-      });
-    });
-
-    it('should not build the controller when the dependsOn property is not set', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.buildCategoryFacet).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        0
-      );
-      expect(generateFacetDependencyConditions).toHaveBeenCalledTimes(0);
-    });
-  });
-
-  describe('the facet enablement', () => {
-    describe('when the facet is enabled', () => {
-      beforeAll(() => {
-        functionsMocks.buildCategoryFacet.mockReturnValue({
-          ...categoryFacetControllerMock,
-          state: {...categoryFacetControllerMock.state, enabled: true},
-        });
-      });
-
-      it('should display the facet content', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-        expect(facetContent).not.toBeNull();
-      });
-    });
-
-    describe('when the facet is not enabled', () => {
-      beforeAll(() => {
-        functionsMocks.buildCategoryFacet.mockReturnValue({
-          ...categoryFacetControllerMock,
-          state: {...categoryFacetControllerMock.state, enabled: false},
-        });
-      });
-
-      it('should not display the facet content', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-        expect(facetContent).toBeNull();
-      });
-    });
-
-    afterAll(() => {
-      functionsMocks.buildCategoryFacet.mockReturnValue(
-        categoryFacetControllerMock
-      );
-    });
-  });
-
-  describe('validation of the dependsOn property', () => {
-    let consoleError;
-    beforeAll(() => {
-      consoleError = jest.spyOn(console, 'error').mockImplementation(() => {});
-    });
-
-    describe('when dependsOn.parentFacetId is not provided', () => {
-      it('should display the error component', async () => {
-        const invalidFacetDependency = {
-          expectedValue: 'txt',
-        };
-        const element = createTestComponent({
-          ...defaultOptions,
-          dependsOn: invalidFacetDependency,
-        });
-        await flushPromises();
-
-        const componentError = element.shadowRoot.querySelector(
-          selectors.componentError
-        );
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-
-        expect(consoleError).toHaveBeenCalledTimes(1);
-        expect(consoleError).toHaveBeenCalledWith(parentFacetIdError);
-        expect(componentError).not.toBeNull();
-        expect(facetContent).toBeNull();
-      });
-    });
-
-    describe('when dependsOn.parentFacetId is not a string', () => {
-      it('should display the error component', async () => {
-        const invalidFacetDependency = {
-          parentFacetId: 1,
-          expectedValue: 'txt',
-        };
-        const element = createTestComponent({
-          ...defaultOptions,
-          dependsOn: invalidFacetDependency,
-        });
-        await flushPromises();
-
-        const componentError = element.shadowRoot.querySelector(
-          selectors.componentError
-        );
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-
-        expect(consoleError).toHaveBeenCalledTimes(1);
-        expect(consoleError).toHaveBeenCalledWith(parentFacetIdError);
-        expect(componentError).not.toBeNull();
-        expect(facetContent).toBeNull();
-      });
-    });
-
-    describe('when dependsOn.expectedValue is not a string', () => {
-      it('should display the error component', async () => {
-        const invalidFacetDependency = {
-          parentFacetId: 'filetype',
-          expectedValue: 2,
-        };
-        const element = createTestComponent({
-          ...defaultOptions,
-          dependsOn: invalidFacetDependency,
-        });
-        await flushPromises();
-
-        const componentError = element.shadowRoot.querySelector(
-          selectors.componentError
-        );
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-
-        expect(consoleError).toHaveBeenCalledTimes(1);
-        expect(consoleError).toHaveBeenCalledWith(expectedValueError);
-        expect(componentError).not.toBeNull();
-        expect(facetContent).toBeNull();
-      });
-    });
-  });
-
-  describe('when the component is disconnected', () => {
-    it('should make the condition manager stop watching the facet', async () => {
-      const exampleFacetDependency = {
-        parentFacetId: 'filetype',
-        expectedValue: 'txt',
-      };
-      const element = createTestComponent({
-        ...defaultOptions,
-        dependsOn: exampleFacetDependency,
-      });
-      await flushPromises();
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        1
-      );
-
-      document.body.removeChild(element);
-      expect(functionsMocks.stopWatching).toHaveBeenCalledTimes(1);
-    });
-  });
-});

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

@@ -1,269 +0,0 @@
-import {
-  getNavigateCalledWith,
-  getGenerateUrlCalledWith,
-} from 'lightning/navigation';
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticCitation from '../quanticCitation';
-
-const functionsMocks = {
-  eventHandler: jest.fn((event) => event),
-  exampleSelect: jest.fn(() => {}),
-  exampleBeginDelayedSelect: jest.fn(() => {}),
-  exampleCancelPendingSelect: jest.fn(() => {}),
-};
-
-const exampleCitation = {
-  index: '1',
-  id: '123',
-  title: 'Example title 1',
-  uri: 'https://example.com/',
-  clickUri: 'https://example.com/',
-  permanentid: '1',
-  text: 'text 01',
-};
-
-const exampleSalesforceCitation = {
-  ...exampleCitation,
-  fields: {
-    sfid: '123',
-  },
-};
-const exampleSalesforceKnowledgeArticleCitation = {
-  ...exampleCitation,
-  fields: {
-    sfid: '123',
-    sfkbid: 'foo',
-    sfkavid: 'bar',
-  },
-};
-const exampleSalesforceLink = 'https://www.example-salesforce.com';
-
-const defaultOptions = {
-  citation: exampleCitation,
-  interactiveCitation: {
-    select: () => functionsMocks.exampleSelect(),
-    beginDelayedSelect: () => functionsMocks.exampleBeginDelayedSelect(),
-    cancelPendingSelect: () => functionsMocks.exampleCancelPendingSelect(),
-  },
-};
-
-const selectors = {
-  citation: '.citation',
-  citationLink: '.citation__link',
-  citationTitle: '.citation__title',
-  citationTooltip: 'c-quantic-tooltip',
-  citationTooltipUrl: '[data-testid="citation__tooltip-uri"]',
-};
-
-function createTestComponent(options = defaultOptions) {
-  const element = createElement('c-quantic-citation', {
-    is: QuanticCitation,
-  });
-
-  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.
-async function flushPromises() {
-  return Promise.resolve();
-}
-
-const bindingsMap = {
-  contextmenu: functionsMocks.exampleSelect,
-  click: functionsMocks.exampleSelect,
-  mouseup: functionsMocks.exampleSelect,
-  mousedown: functionsMocks.exampleSelect,
-  touchstart: functionsMocks.exampleBeginDelayedSelect,
-  touchend: functionsMocks.exampleCancelPendingSelect,
-};
-
-function setupEventDispatchTest(eventName) {
-  const handler = (event) => {
-    functionsMocks.eventHandler(event?.detail);
-    document.removeEventListener(eventName, handler);
-  };
-  document.addEventListener(eventName, handler);
-}
-
-describe('c-quantic-citation', () => {
-  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();
-  });
-
-  it('should properly display the citation', async () => {
-    const element = createTestComponent();
-    await flushPromises();
-
-    const citation = element.shadowRoot.querySelector(selectors.citation);
-    const citationLink = element.shadowRoot.querySelector(
-      selectors.citationLink
-    );
-    const citationTitle = element.shadowRoot.querySelector(
-      selectors.citationTitle
-    );
-    const citationTooltip = element.shadowRoot.querySelector(
-      selectors.citationTooltip
-    );
-
-    expect(citation).not.toBeNull();
-    expect(citationLink).not.toBeNull();
-    expect(citationTitle).not.toBeNull();
-    expect(citationTooltip).not.toBeNull();
-
-    expect(citationLink.href).toBe(exampleCitation.clickUri);
-    expect(citationLink.target).toBe('_blank');
-    expect(citationTitle.textContent).toBe(exampleCitation.title);
-  });
-
-  describe('the analytics bindings of the link within the citation', () => {
-    for (const [eventName, action] of Object.entries(bindingsMap)) {
-      it(`should execute the proper action when the ${eventName} is triggered on the link`, async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const link = element.shadowRoot.querySelector(selectors.citationLink);
-        link.dispatchEvent(new CustomEvent(eventName));
-
-        expect(action).toHaveBeenCalledTimes(1);
-      });
-    }
-  });
-
-  describe('hovering over the citation', () => {
-    beforeAll(() => {
-      jest.useFakeTimers();
-    });
-
-    afterAll(() => {
-      jest.useRealTimers();
-    });
-
-    it('should dispatch a citation hover event after hovering over the the citation for more than 1200ms, 200ms debounce duration before hover + 1000ms minimum hover duration', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-      setupEventDispatchTest('quantic__citationhover');
-
-      const citationLink = element.shadowRoot.querySelector(
-        selectors.citationLink
-      );
-      expect(citationLink).not.toBeNull();
-
-      await citationLink.dispatchEvent(
-        new CustomEvent('mouseenter', {bubbles: true})
-      );
-      jest.advanceTimersByTime(1200);
-      await citationLink.dispatchEvent(
-        new CustomEvent('mouseleave', {bubbles: true})
-      );
-
-      expect(functionsMocks.eventHandler).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.eventHandler).toHaveBeenCalledWith({
-        citationHoverTimeMs: 1000,
-      });
-    });
-
-    it('should not dispatch a citation hover event after hovering over the the citation for more than 1200ms', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-      setupEventDispatchTest('quantic__citationhover');
-
-      const citationLink = element.shadowRoot.querySelector(
-        selectors.citationLink
-      );
-      expect(citationLink).not.toBeNull();
-
-      await citationLink.dispatchEvent(
-        new CustomEvent('mouseenter', {bubbles: true})
-      );
-      jest.advanceTimersByTime(500);
-      await citationLink.dispatchEvent(
-        new CustomEvent('mouseleave', {bubbles: true})
-      );
-
-      expect(functionsMocks.eventHandler).toHaveBeenCalledTimes(0);
-    });
-  });
-
-  describe('when the citation source is of type Salesforce', () => {
-    it('should call the navigation mixin to get the Salesforce record URL', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        citation: exampleSalesforceCitation,
-      });
-      await flushPromises();
-
-      const link = element.shadowRoot.querySelector(selectors.citationLink);
-      const {pageReference} = getGenerateUrlCalledWith();
-
-      expect(pageReference.attributes.recordId).toBe(
-        exampleSalesforceCitation.fields.sfid
-      );
-      expect(link.href).toBe(`${exampleSalesforceLink}/`);
-    });
-
-    it('should open the citation link inside Salesforce', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        citation: exampleSalesforceCitation,
-      });
-      await flushPromises();
-
-      const link = element.shadowRoot.querySelector(selectors.citationLink);
-      link.click();
-
-      const {pageReference} = getNavigateCalledWith();
-
-      expect(pageReference.attributes.recordId).toBe(
-        exampleSalesforceCitation.fields.sfid
-      );
-    });
-
-    it('should display the salesforce link inside the tooltip url', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        citation: exampleSalesforceCitation,
-      });
-      await flushPromises();
-
-      const citationTooltipUrl = element.shadowRoot.querySelector(
-        selectors.citationTooltipUrl
-      );
-      expect(citationTooltipUrl).not.toBeNull();
-      expect(citationTooltipUrl.textContent).toBe(exampleSalesforceLink);
-    });
-
-    describe('when the result is a knowledge article', () => {
-      it('should open the citation link inside Salesforce', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          citation: exampleSalesforceKnowledgeArticleCitation,
-        });
-        await flushPromises();
-
-        const link = element.shadowRoot.querySelector(selectors.citationLink);
-        link.click();
-
-        const {pageReference} = getNavigateCalledWith();
-
-        expect(pageReference.attributes.recordId).toBe(
-          exampleSalesforceKnowledgeArticleCitation.fields.sfkavid
-        );
-        expect(link.href).toBe(`${exampleSalesforceLink}/`);
-      });
-    });
-  });
-});