@coveo/quantic 3.33.2 → 3.33.4

package/docs/out/quantic-docs.json

@@ -69,7 +69,7 @@
             {
                 "name": "QuanticCategoryFacet",
                 "attribute": "quantic-category-facet",
-                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences).\nA <code>QuanticCategoryFacet</code> displays field values in a browsable, hierarchical fashion.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
+                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).\nA <code>QuanticCategoryFacet</code> displays field values in a browsable, hierarchical fashion.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
                 "categories": [
                     "Search",
                     "Insight Panel"
@@ -422,7 +422,7 @@
             {
                 "name": "QuanticFacet",
                 "attribute": "quantic-facet",
-                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences).\nA <code>QuanticFacet</code> displays a facet of the results for the current query.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
+                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).\nA <code>QuanticFacet</code> displays a facet of the results for the current query.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
                 "categories": [
                     "Search",
                     "Insight Panel"
@@ -1919,7 +1919,7 @@
                         "name": "initialChoice",
                         "attribute": "initial-choice",
                         "access": "@api",
-                        "description": "<p>The initial selection for the number of result per page. It must be a positive number and should be part of the <code>choicesDisplayed</code> option.\nIf omited or not part of the <code>choicesDisplayed</code> option, it will default to the first value in <code>choicesDisplayed</code>.</p>",
+                        "description": "<p>The initial selection for the number of result per page. It must be a positive number and should be part of the <code>choicesDisplayed</code> option.\nIf omitted or not part of the <code>choicesDisplayed</code> option, it will default to the first value in <code>choicesDisplayed</code>.</p>",
                         "required": false,
                         "defaultValue": "`the first value in 'choicesDisplayed'`",
                         "type": "number"
@@ -2462,7 +2462,7 @@
             {
                 "name": "QuanticSummary",
                 "attribute": "quantic-summary",
-                "description": "<p>The <code>QuanticSummary</code> component displays information about the current range of results (e.g., &quot;Results 1-10 of 123&quot;).</p>",
+                "description": "<p>The <code>QuanticSummary</code> component displays information about the current range of results (for example, &quot;Results 1-10 of 123&quot;).</p>",
                 "categories": [
                     "Search",
                     "Insight Panel"
@@ -2631,7 +2631,7 @@
                         "name": "amount",
                         "attribute": "amount",
                         "access": "@api",
-                        "description": "<p>The amount of the <code>unit</code> of time (e.g., <code>10 days</code>, <code>1 year</code>, etc.).</p>",
+                        "description": "<p>The amount of the <code>unit</code> of time (for example, <code>10 days</code>, <code>1 year</code>, etc.).</p>",
                         "required": false,
                         "defaultValue": "`1`",
                         "type": "number"
@@ -2642,7 +2642,7 @@
                         "access": "@api",
                         "description": "<p>The non-localized label for the timeframe. When defined, it will appear instead of the formatted value.</p>",
                         "required": false,
-                        "defaultValue": "Defaults to the formatted value based on amount, unit & period.",
+                        "defaultValue": "Defaults to the formatted value based on amount, unit, and period.",
                         "type": "string"
                     }
                 ]
@@ -3909,7 +3909,7 @@
                         "name": "label",
                         "attribute": "label",
                         "access": "@api",
-                        "description": "<p>The label dsiplayed inside the heading.</p>",
+                        "description": "<p>The label displayed inside the heading.</p>",
                         "required": true,
                         "defaultValue": "",
                         "type": "string"
@@ -4156,7 +4156,7 @@
             {
                 "name": "QuanticCategoryFacet",
                 "attribute": "quantic-category-facet",
-                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences).\nA <code>QuanticCategoryFacet</code> displays field values in a browsable, hierarchical fashion.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
+                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).\nA <code>QuanticCategoryFacet</code> displays field values in a browsable, hierarchical fashion.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
                 "categories": [
                     "Search",
                     "Insight Panel"
@@ -4418,7 +4418,7 @@
             {
                 "name": "QuanticFacet",
                 "attribute": "quantic-facet",
-                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences).\nA <code>QuanticFacet</code> displays a facet of the results for the current query.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
+                "description": "<p>A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).\nA <code>QuanticFacet</code> displays a facet of the results for the current query.\nCustom captions can be provided by adding caption provider components to the <code>captions</code> named slot.\nSee <a href=\"https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/\">Create a custom caption provider component for Quantic facets</a>.</p>",
                 "categories": [
                     "Search",
                     "Insight Panel"
@@ -5715,7 +5715,7 @@
                         "name": "initialChoice",
                         "attribute": "initial-choice",
                         "access": "@api",
-                        "description": "<p>The initial selection for the number of result per page. It must be a positive number and should be part of the <code>choicesDisplayed</code> option.\nIf omited or not part of the <code>choicesDisplayed</code> option, it will default to the first value in <code>choicesDisplayed</code>.</p>",
+                        "description": "<p>The initial selection for the number of result per page. It must be a positive number and should be part of the <code>choicesDisplayed</code> option.\nIf omitted or not part of the <code>choicesDisplayed</code> option, it will default to the first value in <code>choicesDisplayed</code>.</p>",
                         "required": false,
                         "defaultValue": "`the first value in 'choicesDisplayed'`",
                         "type": "number"
@@ -5952,7 +5952,7 @@
             {
                 "name": "QuanticSummary",
                 "attribute": "quantic-summary",
-                "description": "<p>The <code>QuanticSummary</code> component displays information about the current range of results (e.g., &quot;Results 1-10 of 123&quot;).</p>",
+                "description": "<p>The <code>QuanticSummary</code> component displays information about the current range of results (for example, &quot;Results 1-10 of 123&quot;).</p>",
                 "categories": [
                     "Search",
                     "Insight Panel"
@@ -6121,7 +6121,7 @@
                         "name": "amount",
                         "attribute": "amount",
                         "access": "@api",
-                        "description": "<p>The amount of the <code>unit</code> of time (e.g., <code>10 days</code>, <code>1 year</code>, etc.).</p>",
+                        "description": "<p>The amount of the <code>unit</code> of time (for example, <code>10 days</code>, <code>1 year</code>, etc.).</p>",
                         "required": false,
                         "defaultValue": "`1`",
                         "type": "number"
@@ -6132,7 +6132,7 @@
                         "access": "@api",
                         "description": "<p>The non-localized label for the timeframe. When defined, it will appear instead of the formatted value.</p>",
                         "required": false,
-                        "defaultValue": "Defaults to the formatted value based on amount, unit & period.",
+                        "defaultValue": "Defaults to the formatted value based on amount, unit, and period.",
                         "type": "string"
                     }
                 ]

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

@@ -43,7 +43,7 @@ import {api, LightningElement, track} from 'lwc';
  */
 
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).
  * A `QuanticCategoryFacet` displays field values in a browsable, hierarchical fashion.
  * Custom captions can be provided by adding caption provider components to the `captions` named slot.
  * See [Create a custom caption provider component for Quantic facets](https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/).

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

@@ -5,6 +5,7 @@ import {
 // @ts-ignore
 import {createElement} from 'lwc';
 import QuanticCitation from '../quanticCitation';
+import {debounce} from '../quanticCitation';
 
 const functionsMocks = {
   eventHandler: jest.fn((event) => event),
@@ -112,6 +113,67 @@ describe('c-quantic-citation', () => {
     cleanup();
   });
 
+  describe('debounce function', () => {
+    let mockFnToDebounce;
+    const DEBOUNCE_DELAY = 200;
+
+    beforeEach(() => {
+      jest.useFakeTimers();
+      mockFnToDebounce = jest.fn();
+    });
+
+    afterEach(() => {
+      jest.useRealTimers();
+    });
+
+    // Ensures that rapid calls result in only one execution
+    test('should execute once after the delay and use the arguments from the last call', () => {
+      const debouncedFn = debounce(mockFnToDebounce, DEBOUNCE_DELAY);
+
+      debouncedFn('first');
+      expect(mockFnToDebounce).not.toHaveBeenCalled();
+
+      jest.advanceTimersByTime(DEBOUNCE_DELAY - 100);
+      debouncedFn('middle');
+
+      jest.advanceTimersByTime(DEBOUNCE_DELAY - 100);
+      debouncedFn('last');
+
+      expect(mockFnToDebounce).not.toHaveBeenCalled();
+      jest.advanceTimersByTime(DEBOUNCE_DELAY);
+
+      expect(mockFnToDebounce).toHaveBeenCalledTimes(1);
+      expect(mockFnToDebounce).toHaveBeenCalledWith('last');
+    });
+
+    // Ensures calls separated by more than the delay execute independently.
+    test('should execute multiple times if calls are spaced outside the delay', () => {
+      const debouncedFn = debounce(mockFnToDebounce, DEBOUNCE_DELAY);
+
+      debouncedFn(100);
+      jest.advanceTimersByTime(DEBOUNCE_DELAY);
+      expect(mockFnToDebounce).toHaveBeenCalledTimes(1);
+      expect(mockFnToDebounce).toHaveBeenCalledWith(100);
+
+      debouncedFn(200, {data: 'second'});
+      jest.advanceTimersByTime(DEBOUNCE_DELAY);
+      expect(mockFnToDebounce).toHaveBeenCalledTimes(2);
+      expect(mockFnToDebounce).toHaveBeenCalledWith(200, {data: 'second'});
+    });
+
+    // Ensures that the execution can be canceled before the delay expires.
+    test('should not execute the function if cancel is called before the delay', () => {
+      const debouncedFn = debounce(mockFnToDebounce, DEBOUNCE_DELAY);
+
+      debouncedFn('should not run');
+      jest.advanceTimersByTime(DEBOUNCE_DELAY / 2);
+      debouncedFn.cancel();
+
+      jest.advanceTimersByTime(DEBOUNCE_DELAY * 2);
+      expect(mockFnToDebounce).not.toHaveBeenCalled();
+    });
+  });
+
   it('should properly display the citation', async () => {
     const element = createTestComponent();
     await flushPromises();
@@ -160,6 +222,31 @@ describe('c-quantic-citation', () => {
       jest.useRealTimers();
     });
 
+    it('should display the citation tooltip', async () => {
+      const element = createTestComponent();
+      await flushPromises();
+
+      const citationLink = element.shadowRoot.querySelector(
+        selectors.citationLink
+      );
+      const citationTooltip = element.shadowRoot.querySelector(
+        selectors.citationTooltip
+      );
+
+      expect(citationLink).not.toBeNull();
+      expect(citationTooltip).not.toBeNull();
+
+      // Spy on the tooltip's showTooltip method to verify it gets called
+      const showTooltipSpy = jest.spyOn(citationTooltip, 'showTooltip');
+
+      await citationLink.dispatchEvent(
+        new CustomEvent('mouseenter', {bubbles: true})
+      );
+      jest.advanceTimersByTime(200);
+
+      expect(showTooltipSpy).toHaveBeenCalledTimes(1);
+    });
+
     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();
@@ -173,18 +260,20 @@ describe('c-quantic-citation', () => {
       await citationLink.dispatchEvent(
         new CustomEvent('mouseenter', {bubbles: true})
       );
-      jest.advanceTimersByTime(1200);
+      jest.advanceTimersByTime(1000);
       await citationLink.dispatchEvent(
         new CustomEvent('mouseleave', {bubbles: true})
       );
+      // Additional 200ms delay for the new hide tooltip logic
+      jest.advanceTimersByTime(200);
 
       expect(functionsMocks.eventHandler).toHaveBeenCalledTimes(1);
       expect(functionsMocks.eventHandler).toHaveBeenCalledWith({
-        citationHoverTimeMs: 1000,
+        citationHoverTimeMs: 1200,
       });
     });
 
-    it('should not dispatch a citation hover event after hovering over the the citation for more than 1200ms', async () => {
+    it('should not dispatch a citation hover event after hovering over the citation for less than 1200ms', async () => {
       const element = createTestComponent();
       await flushPromises();
       setupEventDispatchTest('quantic__citationhover');
@@ -201,9 +290,59 @@ describe('c-quantic-citation', () => {
       await citationLink.dispatchEvent(
         new CustomEvent('mouseleave', {bubbles: true})
       );
+      // Additional 200ms delay for the new hide tooltip logic
+      jest.advanceTimersByTime(200);
 
       expect(functionsMocks.eventHandler).toHaveBeenCalledTimes(0);
     });
+
+    describe('when moving the cursor between the citation link and the tooltip', () => {
+      it('should keep the tooltip displayed', async () => {
+        const element = createTestComponent();
+        await flushPromises();
+
+        const citationLink = element.shadowRoot.querySelector(
+          selectors.citationLink
+        );
+        const citationTooltip = element.shadowRoot.querySelector(
+          selectors.citationTooltip
+        );
+
+        expect(citationLink).not.toBeNull();
+        expect(citationTooltip).not.toBeNull();
+
+        const hideTooltipSpy = jest.spyOn(citationTooltip, 'hideTooltip');
+
+        // Hover over the citation
+        await citationLink.dispatchEvent(
+          new CustomEvent('mouseenter', {bubbles: true})
+        );
+        jest.advanceTimersByTime(200);
+
+        // Move cursor to tooltip in less than 200ms
+        await citationLink.dispatchEvent(
+          new CustomEvent('mouseleave', {bubbles: true})
+        );
+        jest.advanceTimersByTime(100);
+        await citationTooltip.dispatchEvent(
+          new CustomEvent('mouseenter', {bubbles: true})
+        );
+
+        // Move cursor back to citation in less than 200ms
+        await citationTooltip.dispatchEvent(
+          new CustomEvent('mouseleave', {bubbles: true})
+        );
+        jest.advanceTimersByTime(100);
+        await citationLink.dispatchEvent(
+          new CustomEvent('mouseenter', {bubbles: true})
+        );
+
+        // Advance time beyond 200ms to see if tooltip is hidden
+        jest.advanceTimersByTime(300);
+
+        expect(hideTooltipSpy).toHaveBeenCalledTimes(0);
+      });
+    });
   });
 
   describe('when citation anchoring is enabled', () => {

package/force-app/main/default/lwc/quanticCitation/quanticCitation.html

@@ -8,9 +8,9 @@
       href={hrefValue}
       target="_blank"
       rel="noopener"
-      onmouseenter={handleMouseEnter}
-      onmouseleave={handleMouseLeave}
-      onclick={handleClick} 
+      onmouseenter={handleCitationMouseEnter}
+      onmouseleave={handleCitationMouseLeave}
+      onclick={handleClick}
     >
       <p
         class="citation__title slds-m-left_x-small slds-truncate slds-has-flexi-truncate"
@@ -18,7 +18,13 @@
         {citationTitle}
       </p>
     </a>
-    <c-quantic-tooltip light-theme class="slds-show_medium" target={template.host}>
+    <c-quantic-tooltip
+      light-theme
+      class="slds-show_medium"
+      target={template.host}
+      onmouseenter={handleTooltipMouseEnter}
+      onmouseleave={handleTooltipMouseLeave}
+    >
       <div class="citation__tooltip" slot="content">
         <div data-testid="citation__tooltip-uri" class="slds-text-body_small slds-text-color_weak slds-truncate slds-var-p-vertical_xxx-small">{hrefValue}</div>
         <div data-testid="citation__tooltip-title" class="slds-text-title_bold slds-var-p-vertical_xx-small">{citationTitle}</div>

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

@@ -5,10 +5,28 @@ import {LightningElement, api} from 'lwc';
 /** @typedef {import("coveo").InteractiveCitation} InteractiveCitation */
 
 const minimumTooltipDisplayDurationMs = 1000;
-const debounceDurationBeforeHoverMs = 200;
-
+const tooltipHideDelayMs = 200;
 const supportedFileTypesForTextFragment = ['html', 'SalesforceItem'];
 
+/**
+ * Debounce function that delays invoking func until after wait milliseconds
+ * have elapsed since the last time the debounced function was invoked.
+ * Includes a cancel method to clear any pending timeout.
+ * @param {Function} fn - The function to debounce
+ * @param {number} delay - The number of milliseconds to delay
+ * @returns {Function} The debounced function with cancel method
+ */
+export function debounce(fn, delay) {
+  let timeout;
+  const debounced = (...args) => {
+    clearTimeout(timeout);
+    // eslint-disable-next-line @lwc/lwc/no-async-operation
+    timeout = setTimeout(() => fn(...args), delay);
+  };
+  debounced.cancel = () => clearTimeout(timeout);
+  return debounced;
+}
+
 /**
  * The `QuanticCitation` component renders an individual citation.
  * @fires CustomEvent#quantic__citationhover
@@ -42,8 +60,6 @@ export default class QuanticCitation extends NavigationMixin(LightningElement) {
   /** @type {number} */
   hoverStartTimestamp;
   /** @type {boolean} */
-  shouldShowTooltipAfterDelay = false;
-  /** @type {boolean} */
   tooltipIsDisplayed = false;
   /** @type {function} */
   removeBindings;
@@ -53,6 +69,8 @@ export default class QuanticCitation extends NavigationMixin(LightningElement) {
   salesforceRecordUrl;
   /** @type {boolean} */
   isHrefWithTextFragment = false;
+  /** @type {Object} */
+  hideTooltipDebounced;
 
   connectedCallback() {
     const fileType = this.citation?.fields?.filetype;
@@ -60,6 +78,15 @@ export default class QuanticCitation extends NavigationMixin(LightningElement) {
       !this.disableCitationAnchoring &&
       supportedFileTypesForTextFragment.includes(fileType) &&
       !!this.text;
+
+    // Initialize the debounced hide tooltip function
+    this.hideTooltipDebounced = debounce(() => {
+      if (this.tooltipIsDisplayed) {
+        this.dispatchCitationHoverEvent();
+      }
+      this.tooltipIsDisplayed = false;
+      this.tooltipComponent?.hideTooltip();
+    }, tooltipHideDelayMs);
   }
 
   renderedCallback() {
@@ -83,39 +110,53 @@ export default class QuanticCitation extends NavigationMixin(LightningElement) {
 
   disconnectedCallback() {
     this.removeBindings?.();
+    clearTimeout(this.timeout);
+    this.hideTooltipDebounced?.cancel();
   }
 
-  handleMouseEnter() {
-    this.shouldShowTooltipAfterDelay = true;
-    // eslint-disable-next-line @lwc/lwc/no-async-operation
-    this.timeout = setTimeout(() => {
-      if (this.shouldShowTooltipAfterDelay) {
-        this.hoverStartTimestamp = Date.now();
-        this.tooltipIsDisplayed = true;
-        this.tooltipComponent.showTooltip();
-      }
-    }, debounceDurationBeforeHoverMs);
+  handleCitationMouseEnter() {
+    this.showTooltip();
   }
 
-  handleMouseLeave() {
-    clearTimeout(this.timeout);
-    if (this.tooltipIsDisplayed) {
-      const tooltipDisplayDuration = Date.now() - this.hoverStartTimestamp;
-      if (tooltipDisplayDuration >= minimumTooltipDisplayDurationMs) {
-        this.dispatchEvent(
-          new CustomEvent('quantic__citationhover', {
-            detail: {
-              citationHoverTimeMs: Date.now() - this.hoverStartTimestamp,
-            },
-            bubbles: true,
-          })
-        );
-      }
+  handleCitationMouseLeave() {
+    this.hideTooltipDebounced();
+  }
+
+  handleTooltipMouseEnter() {
+    this.hideTooltipDebounced.cancel();
+  }
+
+  handleTooltipMouseLeave() {
+    this.hideTooltipDebounced();
+  }
+
+  /**
+   * Shows the tooltip immediately and cancels any pending hide.
+   */
+  showTooltip() {
+    this.hideTooltipDebounced.cancel();
+    if (!this.tooltipIsDisplayed) {
+      this.hoverStartTimestamp = Date.now();
+      this.tooltipIsDisplayed = true;
+      this.tooltipComponent?.showTooltip();
     }
+  }
 
-    this.tooltipIsDisplayed = false;
-    this.shouldShowTooltipAfterDelay = false;
-    this.tooltipComponent.hideTooltip();
+  /**
+   * Dispatches the citation hover analytics event if minimum display duration was met.
+   */
+  dispatchCitationHoverEvent() {
+    const tooltipDisplayDuration = Date.now() - this.hoverStartTimestamp;
+    if (tooltipDisplayDuration >= minimumTooltipDisplayDurationMs) {
+      this.dispatchEvent(
+        new CustomEvent('quantic__citationhover', {
+          detail: {
+            citationHoverTimeMs: tooltipDisplayDuration,
+          },
+          bubbles: true,
+        })
+      );
+    }
   }
 
   /**

package/force-app/main/default/lwc/quanticFacet/quanticFacet.js

@@ -46,7 +46,7 @@ import {LightningElement, track, api} from 'lwc';
  */
 
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (e.g., number of occurrences).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).
  * A `QuanticFacet` displays a facet of the results for the current query.
  * Custom captions can be provided by adding caption provider components to the `captions` named slot.
  * See [Create a custom caption provider component for Quantic facets](https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/).

package/force-app/main/default/lwc/quanticHeading/quanticHeading.js

@@ -8,7 +8,7 @@ import {LightningElement, api} from 'lwc';
  */
 export default class QuanticHeading extends LightningElement {
   /**
-   * The label dsiplayed inside the heading.
+   * The label displayed inside the heading.
    * @api
    * @type {string}
    */

package/force-app/main/default/lwc/quanticResultsPerPage/quanticResultsPerPage.js

@@ -42,7 +42,7 @@ export default class QuanticResultsPerPage extends LightningElement {
   }
   /**
    * The initial selection for the number of result per page. It must be a positive number and should be part of the `choicesDisplayed` option.
-   * If omited or not part of the `choicesDisplayed` option, it will default to the first value in `choicesDisplayed`.
+   * If omitted or not part of the `choicesDisplayed` option, it will default to the first value in `choicesDisplayed`.
    * @api
    * @type {number}
    * @defaultValue `the first value in 'choicesDisplayed'`

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

@@ -1,7 +1,6 @@
 import {testSearch, testInsight} from './fixture';
 import {
   useCaseTestCases,
-  useCaseEnum,
 } from '../../../../../../playwright/utils/useCase';
 import {
   AnalyticsModeEnum,
@@ -117,10 +116,6 @@ useCaseTestCases.forEach((useCase) => {
           });
 
           test.describe('when clicking on a recent query', () => {
-            test.skip(
-              useCase.value === useCaseEnum.insight,
-              'Recent queries are not available in Insight use case'
-            );
             test.use({
               recentQueries: mockRecentQueries,
             });
@@ -157,10 +152,6 @@ useCaseTestCases.forEach((useCase) => {
           });
 
           test.describe('when clicking on the clear recent queries button', () => {
-            test.skip(
-              useCase.value === useCaseEnum.insight,
-              'Recent queries are not available in Insight use case'
-            );
             test.use({
               recentQueries: mockRecentQueries,
             });
@@ -224,10 +215,6 @@ useCaseTestCases.forEach((useCase) => {
           });
 
           test.describe('when selecting a recent query', () => {
-            test.skip(
-              useCase.value === useCaseEnum.insight,
-              'Recent queries are not available in Insight use case'
-            );
             test.use({
               recentQueries: mockRecentQueries,
             });
@@ -265,10 +252,6 @@ useCaseTestCases.forEach((useCase) => {
           });
 
           test.describe('when selecting the clear recent queries button', () => {
-            test.skip(
-              useCase.value === useCaseEnum.insight,
-              'Recent queries are not available in Insight use case'
-            );
             test.use({
               recentQueries: mockRecentQueries,
             });

package/force-app/main/default/lwc/quanticSummary/quanticSummary.js

@@ -18,7 +18,7 @@ import {LightningElement, track, api} from 'lwc';
 /** @typedef {import("coveo").QuerySummaryState} QuerySummaryState */
 
 /**
- * The `QuanticSummary` component displays information about the current range of results (e.g., "Results 1-10 of 123").
+ * The `QuanticSummary` component displays information about the current range of results (for example, "Results 1-10 of 123").
  * @category Search
  * @category Insight Panel
  * @example

package/force-app/main/default/lwc/quanticTimeframe/quanticTimeframe.js

@@ -29,7 +29,7 @@ export default class QuanticTimeframe extends LightningElement {
   @api unit = 'day';
 
   /**
-   * The amount of the `unit` of time (e.g., `10 days`, `1 year`, etc.).
+   * The amount of the `unit` of time (for example, `10 days`, `1 year`, etc.).
    * @api
    * @type {number}
    * @defaultValue `1`
@@ -40,7 +40,7 @@ export default class QuanticTimeframe extends LightningElement {
    * The non-localized label for the timeframe. When defined, it will appear instead of the formatted value.
    * @api
    * @type {string}
-   * @defaultValue Defaults to the formatted value based on amount, unit & period.
+   * @defaultValue Defaults to the formatted value based on amount, unit, and period.
    */
   @api label;
 }

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

@@ -7,13 +7,13 @@
 /**
  * @typedef {Object} SimpleFacetValue
  * @property {string} value - The value of the facet.
- * @property {string} state - The state of the facet (e.g., "selected").
+ * @property {string} state - The state of the facet (for example, "selected").
  */
 
 /**
  * @typedef {Object} CategoryFacetValue
  * @property {string} value - The value of the facet.
- * @property {string} state - The state of the facet (e.g., "selected").
+ * @property {string} state - The state of the facet (for example, "selected").
  * @property {SimpleFacetValue[]} children - An array of SimpleFacetValue representing child categories.
  */
 

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

@@ -507,10 +507,10 @@ export class DateUtils {
    * Parses a given timestamp into detailed date components.
    * @param {number} timestamp - The timestamp in milliseconds since January 1, 1970 (epoch time).
    * @returns {Object} An object containing the following date details:
-   *   - {number} year - The four-digit year (e.g., 2024).
-   *   - {string} month - The full name of the month (e.g., "August").
-   *   - {string} dayOfWeek - The abbreviated name of the day of the week (e.g., "Mon").
-   *   - {number} day - The day of the month (e.g., 26).
+   *   - {number} year - The four-digit year (for example, 2024).
+   *   - {string} month - The full name of the month (for example, "August").
+   *   - {string} dayOfWeek - The abbreviated name of the day of the week (for example, "Mon").
+   *   - {number} day - The day of the month (for example, 26).
    *   - {number} hours - The hour of the day in 24-hour format (0-23).
    *   - {number} minutes - The minutes of the hour (0-59).
    */