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

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

@@ -1,340 +0,0 @@
-/* eslint-disable jest/expect-expect */
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticResultChildren from '../quanticResultChildren';
-
-const loadRelatedItems = 'Load related items';
-const hideRelatedItems = 'Hide related items';
-jest.mock(
-  '@salesforce/label/c.quantic_LoadRelatedItems',
-  () => ({default: loadRelatedItems}),
-  {
-    virtual: true,
-  }
-);
-jest.mock(
-  '@salesforce/label/c.quantic_HideRelatedItems',
-  () => ({default: hideRelatedItems}),
-  {
-    virtual: true,
-  }
-);
-
-const functionsMocks = {
-  loadCollection: jest.fn(() => {}),
-  logShowLessFoldedResults: jest.fn(() => {}),
-  logShowMoreFoldedResults: jest.fn(() => {}),
-};
-
-const mockedFoldedResultListController = {
-  loadCollection: functionsMocks.loadCollection,
-  logShowLessFoldedResults: functionsMocks.logShowLessFoldedResults,
-  logShowMoreFoldedResults: functionsMocks.logShowMoreFoldedResults,
-};
-
-const selectors = {
-  quanticResult: 'c-quantic-result',
-  toggleButton: '.result-children__toggle-button lightning-button',
-  placeholder: 'c-quantic-placeholder',
-  noMoreChildrenMessage: '.result-children__no-more-children-message',
-};
-
-const exampleFoldedResultOne = {
-  result: {
-    uniqueId: '123',
-    title: 'example result one',
-  },
-  children: [],
-};
-const exampleFoldedResultTwo = {
-  result: {
-    uniqueId: '456',
-    title: 'example result two',
-  },
-  children: [],
-};
-const exampleEngineId = 'example engine id';
-const exampleTemplateId = 'example template id';
-const exampleCollection = {
-  result: {
-    uniqueId: '789',
-    title: 'example parent result',
-  },
-  children: [exampleFoldedResultOne],
-  isLoadingMoreResults: false,
-  moreResultsAvailable: true,
-};
-const exampleCollectionWithAllResultsLoaded = {
-  ...exampleCollection,
-  children: [exampleFoldedResultOne, exampleFoldedResultTwo],
-  isLoadingMoreResults: false,
-  moreResultsAvailable: false,
-};
-const exampleCollectionWithAdditionalGrandChild = {
-  ...exampleCollection,
-  children: [
-    {
-      ...exampleFoldedResultOne,
-      children: [...exampleFoldedResultOne.children, exampleFoldedResultTwo],
-    },
-  ],
-  isLoadingMoreResults: false,
-  moreResultsAvailable: false,
-};
-const exampleCollectionWithNoMoreResults = {
-  ...exampleCollection,
-  moreResultsAvailable: false,
-};
-
-const defaultOptions = {
-  engineId: exampleEngineId,
-  templateId: exampleTemplateId,
-  foldedResultListController: mockedFoldedResultListController,
-  collection: exampleCollection,
-};
-
-function createTestComponent(options = defaultOptions) {
-  const element = createElement('c-quantic-result-children', {
-    is: QuanticResultChildren,
-  });
-
-  Object.assign(element, options);
-
-  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));
-}
-
-function cleanup() {
-  jest.clearAllMocks();
-  // 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);
-  }
-}
-
-function expectProperChildResultsDisplay(element, collection) {
-  const childResults = element.shadowRoot.querySelectorAll(
-    selectors.quanticResult
-  );
-  expect(childResults.length).toBe(collection.children.length);
-  collection.children.forEach((foldedResult, index) => {
-    expect(childResults[index].engineId).toBe(exampleEngineId);
-    expect(childResults[index].templateId).toBe(exampleTemplateId);
-    expect(childResults[index].result).toEqual(foldedResult.result);
-    expect(childResults[index].collection).toEqual(foldedResult);
-  });
-}
-
-async function clickFoldedResultToggleButton(element, label) {
-  const foldedResultToggleButton = element.shadowRoot.querySelector(
-    selectors.toggleButton
-  );
-  expect(foldedResultToggleButton).not.toBeNull();
-  expect(foldedResultToggleButton.label).toBe(label);
-  foldedResultToggleButton.click();
-  await flushPromises();
-}
-
-describe('c-quantic-result-children', () => {
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('when there are no child results available in the collection', () => {
-    it('should not display any child results and the no more child results message', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        collection: {
-          ...exampleCollection,
-          moreResultsAvailable: false,
-          children: [],
-        },
-      });
-      await flushPromises();
-
-      const childResult = element.shadowRoot.querySelector(
-        selectors.quanticResult
-      );
-
-      const noMoreChildrenMessage = element.shadowRoot.querySelector(
-        selectors.noMoreChildrenMessage
-      );
-
-      expect(childResult).toBeNull();
-      expect(noMoreChildrenMessage).toBeNull();
-    });
-  });
-
-  describe('when there are more child results available in the collection', () => {
-    it('should display the first partition of the child results', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      expectProperChildResultsDisplay(element, exampleCollection);
-    });
-
-    describe('when more child results are expanded or collapsed', () => {
-      describe('when the child results are being loaded', () => {
-        it('should display the result placeholder', async () => {
-          const element = createTestComponent();
-          await flushPromises();
-
-          await clickFoldedResultToggleButton(element, loadRelatedItems);
-          element.collection = {
-            ...exampleCollection,
-            isLoadingMoreResults: true,
-          };
-          await flushPromises();
-
-          const placeholder = element.shadowRoot.querySelector(
-            selectors.placeholder
-          );
-          expect(placeholder.numberOfRows).toBe(
-            exampleCollection.children.length
-          );
-        });
-      });
-
-      it('should call the right actions and properly display the child results', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-        const foldedResultToggleButton = element.shadowRoot.querySelector(
-          selectors.toggleButton
-        );
-
-        await clickFoldedResultToggleButton(element, loadRelatedItems);
-        expect(functionsMocks.loadCollection).toHaveBeenCalledTimes(1);
-        element.collection = exampleCollectionWithAllResultsLoaded;
-        await flushPromises();
-        expectProperChildResultsDisplay(
-          element,
-          exampleCollectionWithAllResultsLoaded
-        );
-
-        await clickFoldedResultToggleButton(element, hideRelatedItems);
-        expect(functionsMocks.logShowLessFoldedResults).toHaveBeenCalledTimes(
-          1
-        );
-        expectProperChildResultsDisplay(element, exampleCollection);
-
-        await clickFoldedResultToggleButton(element, loadRelatedItems);
-        expect(functionsMocks.logShowMoreFoldedResults).toHaveBeenCalledTimes(
-          1
-        );
-        expectProperChildResultsDisplay(
-          element,
-          exampleCollectionWithAllResultsLoaded
-        );
-        expect(foldedResultToggleButton.label).toBe(hideRelatedItems);
-      });
-
-      describe('when only grand children are available in the collection', () => {
-        it('should properly display the expanded child results', async () => {
-          const element = createTestComponent();
-          await flushPromises();
-          const foldedResultToggleButton = element.shadowRoot.querySelector(
-            selectors.toggleButton
-          );
-
-          await clickFoldedResultToggleButton(element, loadRelatedItems);
-          expect(functionsMocks.loadCollection).toHaveBeenCalledTimes(1);
-          element.collection = exampleCollectionWithAdditionalGrandChild;
-          await flushPromises();
-          expectProperChildResultsDisplay(
-            element,
-            exampleCollectionWithAdditionalGrandChild
-          );
-
-          const noMoreChildrenMessage = element.shadowRoot.querySelector(
-            selectors.noMoreChildrenMessage
-          );
-          expect(noMoreChildrenMessage).toBeNull();
-          expect(foldedResultToggleButton.label).toBe(hideRelatedItems);
-        });
-      });
-    });
-  });
-
-  describe('when there are no more child results available in the collection', () => {
-    it('should display the first partition of the child results', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      expectProperChildResultsDisplay(element, exampleCollection);
-    });
-
-    describe('when trying to load more child results', () => {
-      it('should display the no more child results message', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        await clickFoldedResultToggleButton(element, loadRelatedItems);
-        element.collection = {
-          ...exampleCollection,
-          moreResultsAvailable: false,
-        };
-        await flushPromises();
-
-        const foldedResultToggleButton = element.shadowRoot.querySelector(
-          selectors.toggleButton
-        );
-        const noMoreChildrenMessage = element.shadowRoot.querySelector(
-          selectors.noMoreChildrenMessage
-        );
-
-        expect(functionsMocks.loadCollection).toHaveBeenCalledTimes(1);
-        expectProperChildResultsDisplay(element, exampleCollection);
-        expect(foldedResultToggleButton).toBeNull();
-        expect(noMoreChildrenMessage).not.toBeNull();
-      });
-    });
-
-    describe('when executing a search query after loading the child results', () => {
-      it('should no longer display the no more child results message and display the child results toggle', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        await clickFoldedResultToggleButton(element, loadRelatedItems);
-
-        expect(functionsMocks.loadCollection).toHaveBeenCalledTimes(1);
-        element.collection = exampleCollectionWithNoMoreResults;
-        await flushPromises();
-
-        let foldedResultToggleButton = element.shadowRoot.querySelector(
-          selectors.toggleButton
-        );
-        let noMoreChildrenMessage = element.shadowRoot.querySelector(
-          selectors.noMoreChildrenMessage
-        );
-
-        expectProperChildResultsDisplay(
-          element,
-          exampleCollectionWithNoMoreResults
-        );
-        expect(foldedResultToggleButton).toBeNull();
-        expect(noMoreChildrenMessage).not.toBeNull();
-
-        // Simulates new search query
-        element.collection = exampleCollection;
-        await flushPromises();
-
-        foldedResultToggleButton = element.shadowRoot.querySelector(
-          selectors.toggleButton
-        );
-        noMoreChildrenMessage = element.shadowRoot.querySelector(
-          selectors.noMoreChildrenMessage
-        );
-
-        expectProperChildResultsDisplay(element, exampleCollection);
-        expect(foldedResultToggleButton).not.toBeNull();
-        expect(noMoreChildrenMessage).toBeNull();
-        expect(foldedResultToggleButton.label).toBe(loadRelatedItems);
-      });
-    });
-  });
-});

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

@@ -1,144 +0,0 @@
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticResultDate from '../quanticResultDate';
-
-const exampleField = 'exampledatefield';
-const exampleFieldValue = 1670118414000;
-const exampleResult = {
-  raw: {
-    [exampleField]: exampleFieldValue,
-  },
-};
-
-const errorSelector = '.error-message';
-
-const defaultOptions = {
-  result: exampleResult,
-  field: exampleField,
-};
-
-function createTestComponent(options = defaultOptions) {
-  const element = createElement('c-quantic-result-date', {
-    is: QuanticResultDate,
-  });
-
-  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-result-date', () => {
-  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();
-  }
-
-  beforeEach(() => {
-    console.error = 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();
-  });
-
-  describe('when no result is given', () => {
-    it('should show an error', async () => {
-      // @ts-ignore
-      const element = createTestComponent({field: exampleField});
-      await flushPromises();
-      const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-      expect(errorMessage).not.toBeNull();
-      expect(console.error).toHaveBeenCalledWith(
-        'The c-quantic-result-date requires a result and a date field to be specified.'
-      );
-      expect(console.error).toHaveBeenCalledWith(
-        'The "exampledatefield" field value is not a valid timestamp.'
-      );
-    });
-  });
-
-  describe('when no field is given', () => {
-    it('should show an error', async () => {
-      // @ts-ignore
-      const element = createTestComponent({result: exampleResult});
-      await flushPromises();
-
-      const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-      expect(errorMessage).not.toBeNull();
-      expect(console.error).toHaveBeenCalledWith(
-        'The c-quantic-result-date requires a result and a date field to be specified.'
-      );
-      expect(console.error).toHaveBeenCalledWith(
-        'The "undefined" field value is not a valid timestamp.'
-      );
-    });
-  });
-
-  describe('when the field value is not a valid timestamp', () => {
-    const invalidValue = 'not-a-timestamp';
-    const invalidOptions = {
-      ...defaultOptions,
-      result: {
-        raw: {
-          [exampleField]: invalidValue,
-        },
-      },
-    };
-
-    it('should show an error', async () => {
-      // @ts-ignore
-      const element = createTestComponent(invalidOptions);
-      await flushPromises();
-
-      const errorMessage = element.shadowRoot.querySelector(errorSelector);
-
-      expect(errorMessage).not.toBeNull();
-    });
-  });
-
-  describe('when a formatting function is given', () => {
-    let formattingFunctionMock;
-
-    beforeEach(() => {
-      formattingFunctionMock = jest
-        .fn()
-        .mockImplementation((value) => `formatted ${value}`);
-    });
-
-    it('should render the formatted field value', async () => {
-      createTestComponent({
-        ...defaultOptions,
-        formattingFunction: formattingFunctionMock,
-      });
-      await flushPromises();
-
-      expect(formattingFunctionMock).toHaveBeenCalledWith(exampleFieldValue);
-    });
-  });
-});

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

@@ -1,120 +0,0 @@
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticResultField from '../quanticResultField';
-
-const invalidType = 'invalid type';
-
-const fieldTypes = [
-  {
-    name: 'string',
-    element: 'c-quantic-result-text',
-  },
-  {
-    name: 'date',
-    element: 'c-quantic-result-date',
-  },
-  {
-    name: 'number',
-    element: 'c-quantic-result-number',
-  },
-  {
-    name: 'multi',
-    element: 'c-quantic-result-multi-value-text',
-  },
-];
-
-const defaultOptions = {
-  result: {
-    raw: {
-      testField: 'test value',
-    },
-  },
-  field: 'testField',
-  label: 'test label',
-  type: 'string',
-};
-
-function createTestComponent(options = defaultOptions) {
-  const element = createElement('c-quantic-result-field', {
-    is: QuanticResultField,
-  });
-
-  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));
-}
-
-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);
-  }
-}
-
-describe('c-quantic-result-field', () => {
-  beforeEach(() => {
-    console.error = 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();
-  });
-
-  describe('when the field type is invalid', () => {
-    it('should display an error', async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        type: invalidType,
-      });
-      await flushPromises();
-
-      const error = element.shadowRoot.querySelector('.error-message');
-
-      expect(error).not.toBeNull();
-      expect(error.textContent).toBe('c-quantic-result-field Error');
-      expect(console.error).toHaveBeenCalledWith(
-        `The provided type "${invalidType}" is invalid. The type must be one of multi | number | date | string`
-      );
-    });
-  });
-
-  fieldTypes.forEach((fieldType) => {
-    it(`should correctly display the result field of type ${fieldType.name} value`, async () => {
-      const element = createTestComponent({
-        ...defaultOptions,
-        type: fieldType.name,
-      });
-      await flushPromises();
-
-      const fieldComponent = element.shadowRoot.querySelector(
-        fieldType.element
-      );
-      const {label, field} = fieldComponent;
-
-      expect(fieldComponent).not.toBeNull();
-      expect(label).toBe(defaultOptions.label);
-      expect(field).toBe(defaultOptions.field);
-    });
-  });
-});