@coveo/quantic 3.44.1 → 3.44.2

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

@@ -1,84 +0,0 @@
-import {
-  extractTextToHighlight,
-  generateTextFragmentUrl,
-} from '../citationAnchoringUtils';
-
-describe('c/citationAnchoringUtils', () => {
-  describe('extractTextToHighlight', () => {
-    it('returns the first sentence of a passage', () => {
-      const text =
-        'This is the first sentence. This is the second sentence. This is the third sentence.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is the first sentence.');
-    });
-
-    it('returns first full sentence even when passages begin in the middle of a sentence', () => {
-      const text =
-        'middle of a sentence. This is the first full sentence. This is the second sentence.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is the first full sentence.');
-    });
-
-    it('returns the first five words as a fallback if no sentences are found', () => {
-      const text = 'This is a test using the fallback';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is a test using');
-    });
-
-    it('handles text with fewer than 5 words', () => {
-      const text = 'short text';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('short text');
-    });
-
-    it('handles empty strings', () => {
-      const text = '';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('');
-    });
-
-    it('trims whitespace from extracted sentence', () => {
-      const text =
-        '   This is a sentence with leading spaces. This is another sentence.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is a sentence with leading spaces.');
-    });
-
-    it("handles text with decimal numbers that shouldn't break sentence detection", () => {
-      const text =
-        'This sentence has the decimal 3.1415 in it. This is another sentence.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This sentence has the decimal 3.1415 in it.');
-    });
-
-    it('handles ellipses in sentences', () => {
-      const text = 'This is the first sentence... This is the second sentence.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is the first sentence...');
-    });
-
-    it('handles multiple punctuation marks', () => {
-      const text = 'This is the first sentence!? Yes, it is.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is the first sentence!?');
-    });
-
-    it('handles commas within sentences', () => {
-      const text =
-        'This is the first sentence, which has a comma. This is the second.';
-      const result = extractTextToHighlight(text);
-      expect(result).toBe('This is the first sentence, which has a comma.');
-    });
-  });
-
-  describe('generateTextFragmentUrl', () => {
-    it('generates a text fragment URL with the correct encoding', () => {
-      const uri = 'https://example.com';
-      const text = 'This is a sample text.';
-      const result = generateTextFragmentUrl(uri, text);
-      expect(result).toBe(
-        'https://example.com#:~:text=This%20is%20a%20sample%20text.'
-      );
-    });
-  });
-});

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

@@ -1,92 +0,0 @@
-import {generateFacetDependencyConditions} from 'c/quanticUtils';
-
-describe('facet dependencies utils', () => {
-  describe('generateFacetDependencyConditions', () => {
-    test('throws error when depending on multiple facets', () => {
-      expect(() =>
-        generateFacetDependencyConditions({facet1: 'value1', facet2: 'value2'})
-      ).toThrow("Depending on multiple facets isn't supported");
-    });
-
-    test('returns an array with a single GenericCondition', () => {
-      const dependsOn = {facet1: 'value1'};
-      const result = generateFacetDependencyConditions(dependsOn);
-
-      expect(result).toHaveLength(1);
-      expect(result[0]).toEqual(
-        expect.objectContaining({
-          parentFacetId: 'facet1',
-          condition: expect.any(Function),
-        })
-      );
-    });
-
-    test('condition function returns true when expected value matches SimpleFacetValue', () => {
-      const dependsOn = {facet1: 'value1'};
-      const result = generateFacetDependencyConditions(dependsOn);
-      const conditionFn = result[0].condition;
-
-      const values = [{value: 'value1', state: 'selected'}];
-      expect(conditionFn(values)).toBe(true);
-    });
-
-    test('condition function returns false when expected value does not match SimpleFacetValue', () => {
-      const dependsOn = {facet1: 'value1'};
-      const result = generateFacetDependencyConditions(dependsOn);
-      const conditionFn = result[0].condition;
-
-      const values = [{value: 'otherValue', state: 'selected'}];
-      expect(conditionFn(values)).toBe(false);
-    });
-
-    test('condition function returns true when expected value matches selected CategoryFacetValue', () => {
-      const dependsOn = {facet1: 'categoryValue'};
-      const result = generateFacetDependencyConditions(dependsOn);
-      const conditionFn = result[0].condition;
-
-      const values = [
-        {
-          value: 'parent',
-          state: 'not-selected',
-          children: [{value: 'categoryValue', state: 'selected', children: []}],
-        },
-      ];
-
-      expect(conditionFn(values)).toBe(true);
-    });
-
-    test('condition function returns false when CategoryFacetValue does not contain expected value', () => {
-      const dependsOn = {facet1: 'nonMatchingValue'};
-      const result = generateFacetDependencyConditions(dependsOn);
-      const conditionFn = result[0].condition;
-
-      const values = [
-        {
-          value: 'parent',
-          state: 'not-selected',
-          children: [{value: 'categoryValue', state: 'selected', children: []}],
-        },
-      ];
-
-      expect(conditionFn(values)).toBe(false);
-    });
-
-    test('condition function returns false when CategoryFacetValue is not selected', () => {
-      const dependsOn = {facet1: 'categoryValue'};
-      const result = generateFacetDependencyConditions(dependsOn);
-      const conditionFn = result[0].condition;
-
-      const values = [
-        {
-          value: 'parent',
-          state: 'not-selected',
-          children: [
-            {value: 'categoryValue', state: 'not-selected', children: []},
-          ],
-        },
-      ];
-
-      expect(conditionFn(values)).toBe(false);
-    });
-  });
-});

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

@@ -1,86 +0,0 @@
-import {Store} from 'c/quanticUtils';
-
-describe('storeUtils', () => {
-  describe('Store.facetTypes', () => {
-    it('should expose the expected facet type keys', () => {
-      expect(Store.facetTypes).toEqual({
-        FACETS: 'facets',
-        NUMERICFACETS: 'numericFacets',
-        DATEFACETS: 'dateFacets',
-        CATEGORYFACETS: 'categoryFacets',
-      });
-    });
-  });
-
-  describe('Store.initialize', () => {
-    it('should return a store with empty state', () => {
-      const store = Store.initialize();
-      expect(store).toEqual({
-        state: {
-          facets: {},
-          numericFacets: {},
-          dateFacets: {},
-          categoryFacets: {},
-          sort: {},
-        },
-      });
-    });
-  });
-
-  describe('Store.registerFacetToStore', () => {
-    it('should register facet data under the given facet type and id', () => {
-      const store = Store.initialize();
-      const data = {facetId: 'author', label: 'Author'};
-      Store.registerFacetToStore(store, 'facets', data);
-      expect(store.state.facets.author).toEqual(data);
-    });
-
-    it('should not overwrite an existing facet entry', () => {
-      const store = Store.initialize();
-      const data = {facetId: 'author', label: 'Author'};
-      Store.registerFacetToStore(store, 'facets', data);
-      Store.registerFacetToStore(store, 'facets', {
-        facetId: 'author',
-        label: 'Updated',
-      });
-      expect(store.state.facets.author.label).toBe('Author');
-    });
-  });
-
-  describe('Store.registerSortOptionDataToStore', () => {
-    it('should set sort data on the store', () => {
-      const store = Store.initialize();
-      const sortData = [{label: 'Relevance', value: 'relevance'}];
-      Store.registerSortOptionDataToStore(store, sortData);
-      expect(store.state.sort).toBe(sortData);
-    });
-  });
-
-  describe('Store.getFromStore', () => {
-    it('should return facet data for the given type', () => {
-      const store = Store.initialize();
-      const data = {facetId: 'source', label: 'Source'};
-      Store.registerFacetToStore(store, 'facets', data);
-      expect(Store.getFromStore(store, 'facets')).toEqual({source: data});
-    });
-
-    it('should return an empty object when no facets are registered', () => {
-      const store = Store.initialize();
-      expect(Store.getFromStore(store, 'facets')).toEqual({});
-    });
-  });
-
-  describe('Store.getSortOptionsFromStore', () => {
-    it('should return the sort options', () => {
-      const store = Store.initialize();
-      const sortData = [{label: 'Date', value: 'date'}];
-      Store.registerSortOptionDataToStore(store, sortData);
-      expect(Store.getSortOptionsFromStore(store)).toBe(sortData);
-    });
-
-    it('should return an empty object when no sort options are registered', () => {
-      const store = Store.initialize();
-      expect(Store.getSortOptionsFromStore(store)).toEqual({});
-    });
-  });
-});

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

@@ -1,109 +0,0 @@
-// This is the same js file as what we load inside the LWC via a static resource.
-import {transformMarkdownToHtml} from 'c/quanticUtils';
-import {marked} from 'marked';
-
-const removeLineBreaks = (text) => text.replace(/\n/g, '');
-
-describe('c/markdownUtils', () => {
-  describe('transformMarkdownToHtml', () => {
-    it('should transform markdown text to HTML', () => {
-      const text = 'Hello, world!';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual('<p>Hello, world!</p>');
-    });
-
-    it('should transform markdown code to HTML <pre><code>', () => {
-      const text = '```javascript\nconst foo = "bar";\n```';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<pre><code>const foo = &quot;bar&quot;;</code></pre>'
-      );
-    });
-
-    it('should transform markdown heading to HTML <div> with data-level="answer-heading-${level}"', () => {
-      const text = '# Hello, world!';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<div data-level="answer-heading-1" aria-label="Hello, world!">Hello, world!</div>'
-      );
-    });
-
-    it('should transform markdown heading with formatting to HTML <div>', () => {
-      const text = '# **bold** and *emphasized* title';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<div data-level="answer-heading-1" aria-label="bold and emphasized title"><strong>bold</strong> and <em>emphasized</em> title</div>'
-      );
-    });
-
-    it('should transform markdown list item to HTML <li>', () => {
-      const text = '- Hello, world!';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<ul><li>Hello, world!</li></ul>'
-      );
-    });
-
-    it('should transform markdown table to HTML <div class="scrollable-table">', () => {
-      const text = '| Header |\n| ------ |\n| Cell   |';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<div class="scrollable-table"><table><thead><tr><th>Header</th></tr></thead><tbody><tr><td>Cell</td></tr></tbody></table></div>'
-      );
-    });
-
-    it('should complete unclosed inline elements such as bold, italic, and code', () => {
-      const textBold = '**bold';
-      const resultBold = transformMarkdownToHtml(textBold, marked);
-      expect(removeLineBreaks(resultBold)).toEqual(
-        '<p><strong>bold</strong></p>'
-      );
-
-      const textItalic = '*italic';
-      const resultItalic = transformMarkdownToHtml(textItalic, marked);
-      expect(removeLineBreaks(resultItalic)).toEqual('<p><em>italic</em></p>');
-
-      const textCode = '`code';
-      const resultCode = transformMarkdownToHtml(textCode, marked);
-      expect(removeLineBreaks(resultCode)).toEqual('<p><code>code</code></p>');
-    });
-
-    it('should transform markdown link to HTML <a> with data-answer-inline-link attribute', () => {
-      const text = '[Google](https://google.com)';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<p><a href="https://google.com" data-answer-inline-link="true">Google</a></p>'
-      );
-    });
-
-    it('should transform markdown link with title to HTML <a> with title attribute', () => {
-      const text = '[Google](https://google.com "Search Engine")';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<p><a href="https://google.com" title="Search Engine" data-answer-inline-link="true">Google</a></p>'
-      );
-    });
-
-    it('should escape special characters in link href', () => {
-      const text = '[Link](https://example.com?param="value"&other=test)';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<p><a href="https://example.com?param=&quot;value&quot;&amp;other=test" data-answer-inline-link="true">Link</a></p>'
-      );
-    });
-
-    it('should escape special characters in link title', () => {
-      const text = '[Link](https://example.com "Title with <script> & quotes")';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual(
-        '<p><a href="https://example.com" title="Title with &amp;lt;script&amp;gt; &amp;amp; quotes" data-answer-inline-link="true">Link</a></p>'
-      );
-    });
-
-    it('should render link text as span when href is missing', () => {
-      const text = '[Link]()';
-      const result = transformMarkdownToHtml(text, marked);
-      expect(removeLineBreaks(result)).toEqual('<p><span>Link</span></p>');
-    });
-  });
-});

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

@@ -1,233 +0,0 @@
-import {
-  I18nUtils,
-  buildTemplateTextFromResult,
-  copyToClipboard,
-  unwrapLockerProxiedObject,
-} from 'c/quanticUtils';
-
-describe('c/quanticUtils', () => {
-  describe('I18nUtils', () => {
-    it('getTextWithDecorator should return text wrapped in given tags', () => {
-      const text = 'sample text';
-      const startTag = '<test-start-tag>';
-      const endTag = '<test-end-tag>';
-      expect(I18nUtils.getTextWithDecorator(text, startTag, endTag)).toBe(
-        `${startTag}${text}${endTag}`
-      );
-    });
-
-    it('getTextBold should return text wrapped in bold tags', () => {
-      const text = 'sample text';
-      expect(I18nUtils.getTextBold(text)).toBe(`<b>${text}</b>`);
-    });
-
-    describe('getLabelNameWithCount', () => {
-      const testLabelName = 'thisLabelName';
-      const testLabelNamePlural = `${testLabelName}_plural`;
-      const testLabelNameZero = `${testLabelName}_zero`;
-
-      it('should return plural variant if count not equal to 1', () => {
-        expect(I18nUtils.getLabelNameWithCount(testLabelName, 99)).toBe(
-          testLabelNamePlural
-        );
-      });
-
-      it('should return plural variant if count is fraction of 1', () => {
-        expect(I18nUtils.getLabelNameWithCount(testLabelName, 0.5)).toBe(
-          testLabelNamePlural
-        );
-      });
-
-      it('should return zero variant if count is 0', () => {
-        expect(I18nUtils.getLabelNameWithCount(testLabelName, 0)).toBe(
-          testLabelNameZero
-        );
-      });
-
-      it('should return singular variant if count is equal to 1', () => {
-        expect(I18nUtils.getLabelNameWithCount(testLabelName, 1)).toBe(
-          testLabelName
-        );
-      });
-
-      it('should return singular variant if count is equal to -1', () => {
-        expect(I18nUtils.getLabelNameWithCount(testLabelName, -1)).toBe(
-          testLabelName
-        );
-      });
-
-      describe('given other locale', () => {
-        jest.resetModules();
-        jest.mock('@salesforce/i18n/locale', () => ({
-          default: 'de-DE',
-        }));
-        const withOtherLocale = require('c/quanticUtils');
-
-        it('should return label name without failing', () => {
-          expect(() =>
-            withOtherLocale.I18nUtils.getLabelNameWithCount(testLabelName, 2)
-          ).not.toThrow();
-        });
-      });
-    });
-
-    describe('format', () => {
-      it('should throw an error if the given string is not a string', () => {
-        let caughtError;
-        try {
-          I18nUtils.format(undefined);
-        } catch (error) {
-          caughtError = error;
-        }
-        expect(caughtError).toBeDefined();
-      });
-
-      it('should return the given string if no formatting arguments are given', () => {
-        const testString = 'this is a test string';
-        expect(I18nUtils.format(testString)).toBe(testString);
-      });
-
-      it('should return the given string with formatting arguments inserted in order', () => {
-        const testString = 'this is a {{0}} string, {{1}}.';
-        const test = 'test';
-        const buddy = 'buddy';
-        expect(I18nUtils.format(testString, test, buddy)).toBe(
-          'this is a test string, buddy.'
-        );
-      });
-    });
-
-    describe('escapeHTML', () => {
-      it('should escape html tags', () => {
-        let htmlWithTags = '<div>test string</div>';
-
-        expect(I18nUtils.escapeHTML(htmlWithTags)).toBe(
-          '&lt;div&gt;test string&lt;/div&gt;'
-        );
-      });
-
-      it('should escape html anchor tags', () => {
-        let htmlWithTags = '<a src="http://www.sketchysite.com"></a>';
-
-        expect(I18nUtils.escapeHTML(htmlWithTags)).toBe(
-          '&lt;a src="http://www.sketchysite.com"&gt;&lt;/a&gt;'
-        );
-      });
-    });
-  });
-
-  describe('copy to clipboard', () => {
-    const mockExecCommand = jest.fn(() => {});
-    const mockWriteText = jest.fn(() => new Promise(() => {}));
-
-    beforeAll(() => {
-      Object.defineProperty(document, 'execCommand', {
-        value: mockExecCommand,
-        writable: true,
-      });
-    });
-
-    afterEach(() => {
-      jest.clearAllMocks();
-    });
-
-    describe('when the Clipboard API is available', () => {
-      it('should correctly perform the copy to clipboard operation using the writeText method', () => {
-        const exampleText = 'example text';
-
-        Object.defineProperty(navigator, 'clipboard', {
-          value: {
-            ...navigator.clipboard,
-            writeText: mockWriteText,
-          },
-          writable: true,
-        });
-
-        copyToClipboard(exampleText);
-        expect(mockWriteText).toHaveBeenCalledTimes(1);
-        expect(mockWriteText.mock.calls[0][0]).toBe(exampleText);
-        expect(mockExecCommand).toHaveBeenCalledTimes(0);
-      });
-    });
-
-    describe('when the Clipboard API is not available', () => {
-      it('should correctly perform the copy to clipboard operation using the DOM method', () => {
-        const exampleText = 'example text';
-
-        Object.defineProperty(navigator, 'clipboard', {
-          value: undefined,
-          writable: true,
-        });
-
-        copyToClipboard(exampleText);
-        expect(mockWriteText).toHaveBeenCalledTimes(0);
-        expect(mockExecCommand).toHaveBeenCalledTimes(1);
-      });
-    });
-  });
-
-  describe('buildTemplateTextFromResult', () => {
-    const testTemplate =
-      '<a href="${clickUri}">${title}</a><br/><br/><quote>${excerpt}</quote>';
-    const testResult = {
-      clickUri: 'https://www.example.com',
-      title: 'Example Title',
-      excerpt: 'This is an example excerpt.',
-    };
-
-    it('should return a string with the result values inserted into the template', () => {
-      // @ts-ignore
-      expect(buildTemplateTextFromResult(testTemplate, testResult)).toBe(
-        `<a href="${testResult.clickUri}">${testResult.title}</a><br/><br/><quote>${testResult.excerpt}</quote>`
-      );
-    });
-
-    it('should return an empty string if the template is undefined or falsy', () => {
-      // @ts-ignore
-      expect(buildTemplateTextFromResult(undefined, testResult)).toBe('');
-    });
-
-    it('should not return the template field name as placeholder if the result does not contain the field', () => {
-      const resultWithoutExcerpt = {
-        clickUri: 'https://www.example.com',
-        title: 'Example Title',
-      };
-
-      // @ts-ignore
-      expect(
-        buildTemplateTextFromResult(testTemplate, resultWithoutExcerpt)
-      ).toBe(
-        `<a href="${testResult.clickUri}">${testResult.title}</a><br/><br/><quote></quote>`
-      );
-    });
-  });
-
-  describe('unwrapLockerObject', () => {
-    it('should deeply clone complex objects while preserving primitive values', () => {
-      const original = {
-        title: 'Example',
-        raw: {
-          foo: 'bar',
-          tags: ['a', {value: 'b'}],
-        },
-        score: 42,
-      };
-
-      const unwrapped = unwrapLockerProxiedObject(original);
-
-      expect(unwrapped).toEqual(original);
-      expect(unwrapped).not.toBe(original);
-      expect(unwrapped.raw).not.toBe(original.raw);
-      expect(unwrapped.raw.tags).not.toBe(original.raw.tags);
-      expect(unwrapped.raw.tags[1]).not.toBe(original.raw.tags[1]);
-    });
-
-    it('should return primitive values as-is', () => {
-      expect(unwrapLockerProxiedObject(undefined)).toBeUndefined();
-      expect(unwrapLockerProxiedObject(null)).toBeNull();
-      expect(unwrapLockerProxiedObject('value')).toBe('value');
-      expect(unwrapLockerProxiedObject(0)).toBe(0);
-      expect(unwrapLockerProxiedObject(false)).toBe(false);
-    });
-  });
-});

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

@@ -1,22 +0,0 @@
-import {TimeSpan} from '../timeAndDateUtils';
-
-describe('quanticUtils/timeAndDateUtils', () => {
-  describe('TimeSpan', () => {
-    describe('getYoutubeFormatTimestamp', () => {
-      it('should return the correct YouTube timestamp format for timestamps of less than a minute', () => {
-        const timeSpan = new TimeSpan(45000);
-        expect(timeSpan.getYoutubeFormatTimestamp()).toBe('0:45');
-      });
-
-      it('should return the correct YouTube timestamp format for timestamps of more than an hour', () => {
-        const timeSpan = new TimeSpan(3661000);
-        expect(timeSpan.getYoutubeFormatTimestamp()).toBe('1:01:01');
-      });
-
-      it('should return the correct YouTube timestamp format for timestamps of less than an hour', () => {
-        const timeSpan = new TimeSpan(300000);
-        expect(timeSpan.getYoutubeFormatTimestamp()).toBe('05:00');
-      });
-    });
-  });
-});