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

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

@@ -1,212 +0,0 @@
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticColoredResultBadge from '../quanticColoredResultBadge';
-
-const badgeSelector = '.result-badge';
-const resultFieldSelector = 'c-quantic-result-field';
-const errorSelector = '.error-message';
-
-const defaultPrimaryColor = '#FFF7BA';
-const defaultSecondaryColor = 'black';
-const exampleLabel = 'Document';
-const exampleColor = '#FFFFFF';
-const defaultOptions = {
-  color: exampleColor,
-  label: exampleLabel,
-  result: {
-    raw: {
-      testField: 'test value',
-    },
-  },
-  field: 'testField',
-  type: 'string',
-};
-
-const coloredResultBadgeError =
-  'The c-quantic-colored-result-badge requires a label or result and a field to be specified.';
-const coloredResultBadgeWarning =
-  'The color property has not been specified, the default colors will be used.';
-const coloredResultBadgeColorError = (color) =>
-  `The "${color}" color is not a valid HEX color.`;
-
-function createTestComponent(options = defaultOptions) {
-  const element = createElement('c-quantic-colored-result-badge', {
-    is: QuanticColoredResultBadge,
-  });
-
-  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-colored-result-badge', () => {
-  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);
-    }
-  }
-
-  beforeEach(() => {
-    console.error = jest.fn();
-    console.warn = jest.fn();
-    // @ts-ignore
-    global.Bueno = {
-      isString: jest
-        .fn()
-        .mockImplementation(
-          (value) => Object.prototype.toString.call(value) === '[object String]'
-        ),
-      isNumber: jest
-        .fn()
-        .mockImplementation(
-          (value) => typeof value === 'number' && !isNaN(value)
-        ),
-    };
-  });
-
-  afterEach(() => {
-    cleanup();
-    jest.clearAllMocks();
-  });
-
-  describe('when the badge is used to display a label', () => {
-    describe('when a label is given', () => {
-      it('should display the colored badge with the correct label and color', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          result: null,
-          field: null,
-        });
-        await flushPromises();
-
-        const badge = element.shadowRoot.querySelector(badgeSelector);
-
-        expect(badge).not.toBeNull();
-        expect(badge.textContent).toBe(exampleLabel);
-        expect(badge.style._values['--primaryColor']).toBe(exampleColor);
-        expect(badge.style._values['--secondaryColor']).toBe('black');
-      });
-    });
-
-    describe('when no label is given', () => {
-      it('should show an error', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          label: null,
-          result: null,
-          field: null,
-        });
-        await flushPromises();
-
-        const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-        expect(errorMessage).not.toBeNull();
-        expect(console.error).toHaveBeenCalledWith(coloredResultBadgeError);
-      });
-    });
-  });
-
-  describe('when the badge is used to display a result field', () => {
-    describe('when a result and a field are provided', () => {
-      it('should display the colored badge with the correct result field', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          label: undefined,
-        });
-        await flushPromises();
-
-        const badge = element.shadowRoot.querySelector(badgeSelector);
-        const resultField =
-          element.shadowRoot.querySelector(resultFieldSelector);
-
-        expect(badge).not.toBeNull();
-        expect(resultField).not.toBeNull();
-        expect(resultField.result).toEqual(defaultOptions.result);
-        expect(resultField.field).toEqual(defaultOptions.field);
-        expect(resultField.type).toEqual(defaultOptions.type);
-        expect(badge.style._values['--primaryColor']).toBe(exampleColor);
-        expect(badge.style._values['--secondaryColor']).toBe('black');
-      });
-    });
-
-    describe('when no result is given', () => {
-      it('should show an error', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          label: null,
-          result: null,
-        });
-        await flushPromises();
-
-        const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-        expect(errorMessage).not.toBeNull();
-        expect(console.error).toHaveBeenCalledWith(coloredResultBadgeError);
-      });
-    });
-
-    describe('when no field is given', () => {
-      it('should show an error', async () => {
-        const element = createTestComponent({
-          ...defaultOptions,
-          label: null,
-          field: null,
-        });
-        await flushPromises();
-
-        const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-        expect(errorMessage).not.toBeNull();
-        expect(console.error).toHaveBeenCalledWith(coloredResultBadgeError);
-      });
-    });
-  });
-
-  describe('when no color is given', () => {
-    it('should display the colored badge with the default colors', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        color: null,
-      });
-      await flushPromises();
-
-      const badge = element.shadowRoot.querySelector(badgeSelector);
-
-      expect(badge).not.toBeNull();
-      expect(badge.textContent).toBe(exampleLabel);
-      expect(badge.style._values['--primaryColor']).toBe(defaultPrimaryColor);
-      expect(badge.style._values['--secondaryColor']).toBe(
-        defaultSecondaryColor
-      );
-      expect(console.warn).toHaveBeenCalledWith(coloredResultBadgeWarning);
-    });
-  });
-
-  describe('when an invalid color is given', () => {
-    it('should show an error', async () => {
-      const invalidColor = 'invalid color';
-      const element = createTestComponent({
-        ...defaultOptions,
-        color: invalidColor,
-      });
-      await flushPromises();
-
-      const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-      expect(errorMessage).not.toBeNull();
-      expect(console.error).toHaveBeenCalledWith(
-        coloredResultBadgeColorError(invalidColor)
-      );
-    });
-  });
-});

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

@@ -1,321 +0,0 @@
-/* eslint-disable no-import-assign */
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticDateFacet from 'c/quanticDateFacet';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-import {generateFacetDependencyConditions} from 'c/quanticUtils';
-
-jest.mock('c/quanticUtils', () => ({
-  generateFacetDependencyConditions: jest.fn(),
-  Store: {
-    facetTypes: {
-      DATEFACETS: 'dateFacets',
-    },
-  },
-  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 dateFacetControllerMock = {
-  subscribe: jest.fn((callback) => callback()),
-  state: {
-    facetId: exampleFacetId,
-    values: [],
-  },
-};
-const parentFacetIdError = `The ${exampleField} c-quantic-date-facet requires dependsOn.parentFacetId to be a valid string.`;
-const expectedValueError = `The ${exampleField} c-quantic-date-facet requires dependsOn.expectedValue to be a valid string.`;
-
-function createTestComponent(options = defaultOptions) {
-  prepareHeadlessState();
-
-  const element = createElement('c-quantic-date-facet', {
-    is: QuanticDateFacet,
-  });
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-
-  document.body.appendChild(element);
-  return element;
-}
-
-const functionsMocks = {
-  buildDateFacet: jest.fn(() => dateFacetControllerMock),
-  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 {
-      buildDateFacet: functionsMocks.buildDateFacet,
-      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 QuanticDateFacet && !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-date-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.buildDateFacet).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.buildDateFacet).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        0
-      );
-      expect(generateFacetDependencyConditions).toHaveBeenCalledTimes(0);
-    });
-  });
-
-  describe('the facet enablement', () => {
-    describe('when the facet is enabled', () => {
-      beforeAll(() => {
-        functionsMocks.buildDateFacet.mockReturnValue({
-          ...dateFacetControllerMock,
-          state: {...dateFacetControllerMock.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.buildDateFacet.mockReturnValue({
-          ...dateFacetControllerMock,
-          state: {...dateFacetControllerMock.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.buildDateFacet.mockReturnValue(dateFacetControllerMock);
-    });
-  });
-
-  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);
-    });
-  });
-});