@coveo/quantic 3.37.8 → 3.37.10

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

@@ -94,7 +94,7 @@ export default class QuanticResult extends LightningElement {
 
   get videoTimeSpan() {
     return new TimeSpan(
-      this.result.raw.ytvideoduration,
+      Number(this.result.raw.ytvideoduration),
       false
     ).getYoutubeFormatTimestamp();
   }

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

@@ -4,6 +4,7 @@ import {
   initializeWithHeadless,
   getHeadlessBundle,
 } from 'c/quanticHeadlessLoader';
+import {unwrapLockerProxiedObject} from 'c/quanticUtils';
 import {LightningElement, api} from 'lwc';
 
 /** @typedef {import("coveo").Result} Result */
@@ -28,7 +29,13 @@ export default class QuanticResultHighlightedTextField extends LightningElement
    * @api
    * @type {Result}
    */
-  @api result;
+  @api
+  get result() {
+    return this._result;
+  }
+  set result(result) {
+    this._result = unwrapLockerProxiedObject(result);
+  }
   /**
    * (Optional) The label to display.
    * @api
@@ -49,6 +56,8 @@ export default class QuanticResultHighlightedTextField extends LightningElement
   isInitialized = false;
   /** @type {boolean} */
   validated = false;
+  /** @type {Result} */
+  _result;
 
   connectedCallback() {
     this.validateProps();

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

@@ -4,7 +4,7 @@ import {
   getHeadlessBundle,
   getHeadlessEnginePromise,
 } from 'c/quanticHeadlessLoader';
-import {ResultUtils} from 'c/quanticUtils';
+import {ResultUtils, unwrapLockerProxiedObject} from 'c/quanticUtils';
 import {NavigationMixin} from 'lightning/navigation';
 import {LightningElement, api} from 'lwc';
 
@@ -38,7 +38,13 @@ export default class QuanticResultLink extends NavigationMixin(
    * @api
    * @type {Result}
    */
-  @api result;
+  @api
+  get result() {
+    return this._result;
+  }
+  set result(result) {
+    this._result = unwrapLockerProxiedObject(result);
+  }
   /**
    * Where to display the linked URL, as the name for a browsing context (a tab, window, or <iframe>).
    * The following keywords have special meanings for where to load the URL:
@@ -75,6 +81,8 @@ export default class QuanticResultLink extends NavigationMixin(
   engine;
   /** @type {AnyHeadless} */
   headless;
+  /** @type {Result} */
+  _result;
   /** @type {string} */
   salesforceRecordUrl;
 
@@ -113,8 +121,7 @@ export default class QuanticResultLink extends NavigationMixin(
     this.engine = engine;
     ResultUtils.bindClickEventsOnResult(
       this.engine,
-      // Destructuring transforms the Proxy object created by Salesforce to a normal object so no unexpected behaviour will occur with the Headless library.
-      {...this.result, raw: {...this.result.raw}},
+      this.result,
       this.template,
       this.headless.buildInteractiveResult
     );

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

@@ -8,7 +8,11 @@ import {
   HeadlessBundleNames,
   isHeadlessBundle,
 } from 'c/quanticHeadlessLoader';
-import {I18nUtils, getLastFocusableElement} from 'c/quanticUtils';
+import {
+  I18nUtils,
+  getLastFocusableElement,
+  unwrapLockerProxiedObject,
+} from 'c/quanticUtils';
 import {LightningElement, api, track} from 'lwc';
 
 /** @typedef {import("coveo").Result} Result */
@@ -42,7 +46,13 @@ export default class QuanticResultQuickview extends LightningElement {
    * @api
    * @type {ResultWithFolding}
    */
-  @api result;
+  @api
+  get result() {
+    return this._result;
+  }
+  set result(result) {
+    this._result = unwrapLockerProxiedObject(result);
+  }
   /**
    * The maximum preview size to retrieve, in bytes. By default, the full preview is retrieved.
    * @api
@@ -84,6 +94,8 @@ export default class QuanticResultQuickview extends LightningElement {
 
   /** @type {Quickview} */
   quickview;
+  /** @type {ResultWithFolding} */
+  _result;
   /** @type {boolean} */
   isQuickviewOpen = false;
   /** @type {Function} */

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

@@ -223,6 +223,11 @@ export default class QuanticSearchBoxInput extends LightningElement {
    * @param {KeyboardEvent} event
    */
   onKeyDown(event) {
+    // Let the browser commit IME text before handling shortcuts like Enter during composition.
+    if (event.isComposing || event.keyCode === 229) {
+      return;
+    }
+
     // eslint-disable-next-line default-case
     switch (event.key) {
       case keys.ESC:

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

@@ -13,14 +13,14 @@ jest.mock('c/quanticUtils', () => ({
   },
   I18nUtils: {
     format: jest.fn(),
+    getLabelNameWithCount: jest.fn(),
+  },
+  DateUtils: {
     formatDate: jest.fn(
       (date) =>
         `${date.getUTCFullYear()}-${date.getUTCMonth() + 1}-${date.getUTCDate()}`
     ),
     getShortDatePattern: jest.fn(),
-    getLabelNameWithCount: jest.fn(),
-  },
-  DateUtils: {
     fromLocalIsoDate: jest.fn((value) => value),
     toLocalSearchApiDate: jest.fn((value) => value),
   },

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

@@ -387,7 +387,7 @@ export default class QuanticTimeframeFacet extends LightningElement {
   }
 
   get datepickerFormat() {
-    return I18nUtils.getShortDatePattern();
+    return DateUtils.getShortDatePattern();
   }
 
   /**
@@ -621,10 +621,10 @@ export default class QuanticTimeframeFacet extends LightningElement {
     }
 
     const start = fromSearchApiDate(facetValue.start);
-    const startDate = I18nUtils.formatDate(new Date(start));
+    const startDate = DateUtils.formatDate(new Date(start));
 
     const end = fromSearchApiDate(facetValue.end);
-    const endDate = I18nUtils.formatDate(new Date(end));
+    const endDate = DateUtils.formatDate(new Date(end));
 
     return `${startDate} - ${endDate}`;
   };

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

@@ -2,7 +2,7 @@ import {
   I18nUtils,
   buildTemplateTextFromResult,
   copyToClipboard,
-  TimeSpan,
+  unwrapLockerProxiedObject,
 } from 'c/quanticUtils';
 
 describe('c/quanticUtils', () => {
@@ -202,22 +202,32 @@ describe('c/quanticUtils', () => {
     });
   });
 
-  describe('TimeSpan', () => {
-    describe('getYoutubeFormatTimestamp', () => {
-      it('should return the correct YouTube timestamp format for timestamps of less than a minute', () => {
-        const timeSpan = new TimeSpan(45000); // 45 seconds
-        expect(timeSpan.getYoutubeFormatTimestamp()).toBe('0:45');
-      });
+  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,
+      };
 
-      it('should return the correct YouTube timestamp format for timestamps of more than an hour', () => {
-        const timeSpan = new TimeSpan(3661000); // 1 hour, 1 minute, and 1 second
-        expect(timeSpan.getYoutubeFormatTimestamp()).toBe('1:01:01');
-      });
+      const unwrapped = unwrapLockerProxiedObject(original);
 
-      it('should return the correct YouTube timestamp format for timestamps of less than an hour', () => {
-        const timeSpan = new TimeSpan(300000); // 5 minutes
-        expect(timeSpan.getYoutubeFormatTimestamp()).toBe('05:00');
-      });
+      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

@@ -0,0 +1,22 @@
+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');
+      });
+    });
+  });
+});

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

@@ -1,33 +1,4 @@
 import LOCALE from '@salesforce/i18n/locale';
-import dayPattern from '@salesforce/label/c.quantic_DatePatternDay';
-import monthPattern from '@salesforce/label/c.quantic_DatePatternMonth';
-import yearPattern from '@salesforce/label/c.quantic_DatePatternYear';
-import nextDay from '@salesforce/label/c.quantic_NextDay';
-import nextDay_plural from '@salesforce/label/c.quantic_NextDay_plural';
-import nextHour from '@salesforce/label/c.quantic_NextHour';
-import nextHour_plural from '@salesforce/label/c.quantic_NextHour_plural';
-import nextMonth from '@salesforce/label/c.quantic_NextMonth';
-import nextMonth_plural from '@salesforce/label/c.quantic_NextMonth_plural';
-import nextQuarter from '@salesforce/label/c.quantic_NextQuarter';
-import nextQuarter_plural from '@salesforce/label/c.quantic_NextQuarter_plural';
-import nextWeek from '@salesforce/label/c.quantic_NextWeek';
-import nextWeek_plural from '@salesforce/label/c.quantic_NextWeek_plural';
-import nextYear from '@salesforce/label/c.quantic_NextYear';
-import nextYear_plural from '@salesforce/label/c.quantic_NextYear_plural';
-import pastDay from '@salesforce/label/c.quantic_PastDay';
-import pastDay_plural from '@salesforce/label/c.quantic_PastDay_plural';
-
-/** @typedef {import("coveo").RelativeDate} RelativeDate */
-import pastHour from '@salesforce/label/c.quantic_PastHour';
-import pastHour_plural from '@salesforce/label/c.quantic_PastHour_plural';
-import pastMonth from '@salesforce/label/c.quantic_PastMonth';
-import pastMonth_plural from '@salesforce/label/c.quantic_PastMonth_plural';
-import pastQuarter from '@salesforce/label/c.quantic_PastQuarter';
-import pastQuarter_plural from '@salesforce/label/c.quantic_PastQuarter_plural';
-import pastWeek from '@salesforce/label/c.quantic_PastWeek';
-import pastWeek_plural from '@salesforce/label/c.quantic_PastWeek_plural';
-import pastYear from '@salesforce/label/c.quantic_PastYear';
-import pastYear_plural from '@salesforce/label/c.quantic_PastYear_plural';
 
 /** @typedef {import("coveo").Result} Result */
 /** @typedef {import("coveo").SortCriterion} SortCriterion */
@@ -36,6 +7,7 @@ export * from './recentQueriesUtils';
 export * from './markdownUtils';
 export * from './facetDependenciesUtils';
 export * from './citationAnchoringUtils';
+export * from './timeAndDateUtils';
 
 /**
  * Utility class for debouncing function calls.
@@ -227,38 +199,6 @@ export class I18nUtils {
     );
   }
 
-  /**
-   * Gets the short date pattern for the current locale.
-   * @returns {string} The short date pattern.
-   * @example `M/d/yyyy` for `en-US`, `d/M/yyyy` for `fr-FR`, etc.
-   */
-  static getShortDatePattern() {
-    const date = new Date(2000, 2, 4); // month is zero-based
-    const dateAsString = I18nUtils.formatDate(date);
-
-    const day = I18nUtils.format(dayPattern);
-    const month = I18nUtils.format(monthPattern);
-    const year = I18nUtils.format(yearPattern);
-
-    return dateAsString
-      .replace('2000', year.repeat(4))
-      .replace('00', year.repeat(2)) // for 2-digits year
-      .replace('03', month.repeat(2))
-      .replace('3', month) // for single-digit month
-      .replace('04', day.repeat(2))
-      .replace('4', day);
-  }
-
-  /**
-   * Formats the date in the current locale.
-   * @param {Date} date
-   * @returns {string} The formatted date.
-   */
-  static formatDate(date) {
-    const formattedDate = new Intl.DateTimeFormat(LOCALE).format(date);
-    return formattedDate;
-  }
-
   /**
    * @param {string} html
    * @returns {string}
@@ -320,303 +260,27 @@ export function parseXML(string) {
 }
 
 /**
- * Utility class for time-based calculations and formatting.
- * Provides methods to convert between different time units and format durations.
- */
-export class TimeSpan {
-  constructor(time, isMilliseconds = true) {
-    if (isMilliseconds) {
-      this.milliseconds = time;
-    } else {
-      this.milliseconds = time * 1000;
-    }
-  }
-
-  getMilliseconds() {
-    return this.milliseconds;
-  }
-
-  getSeconds() {
-    return this.getMilliseconds() / 1000;
-  }
-
-  getMinutes() {
-    return this.getSeconds() / 60;
-  }
-
-  getHours() {
-    return this.getMinutes() / 60;
-  }
-
-  getDays() {
-    return this.getHours() / 24;
-  }
-
-  getWeeks() {
-    return this.getDays() / 7;
-  }
-
-  getHHMMSS() {
-    const hours = Math.floor(this.getHours());
-    const minutes = Math.floor(this.getMinutes()) % 60;
-    const seconds = Math.floor(this.getSeconds()) % 60;
-    let hoursString, minutesString, secondsString;
-    if (hours === 0) {
-      hoursString = '';
-    } else {
-      hoursString = hours < 10 ? '0' + hours.toString() : hours.toString();
-    }
-    minutesString =
-      minutes < 10 ? '0' + minutes.toString() : minutes.toString();
-    secondsString =
-      seconds < 10 ? '0' + seconds.toString() : seconds.toString();
-    const hhmmss =
-      (hoursString !== '' ? hoursString + ':' : '') +
-      minutesString +
-      ':' +
-      secondsString;
-    return hhmmss;
-  }
-
-  getYoutubeFormatTimestamp() {
-    const hours = Math.floor(this.getHours());
-    const minutes = Math.floor(this.getMinutes()) % 60;
-    const seconds = Math.floor(this.getSeconds()) % 60;
-
-    const formattedSeconds = seconds < 10 ? '0' + seconds : seconds;
-
-    if (hours > 0) {
-      const formattedMinutes = minutes < 10 ? '0' + minutes : minutes;
-      return hours + ':' + formattedMinutes + ':' + formattedSeconds;
-    }
-    const formattedMinutes =
-      minutes === 0 ? '0' : minutes < 10 ? '0' + minutes : minutes;
-    return formattedMinutes + ':' + formattedSeconds;
-  }
-
-  getCleanHHMMSS() {
-    return this.getHHMMSS().replace(/^0+/, '');
-  }
-}
-
-/**
- * Utility class for date operations and formatting.
- * Handles conversion between different date formats and provides parsing utilities.
+ * Recursively clones objects to break Locker proxy chains.
+ * @param {any} value
+ * @returns {any}
  */
-export class DateUtils {
-  /**
-   * Converts a date string from the Coveo Search API format to the ISO-8601 format.
-   * Replace `/` characters in date string with `-`.
-   * Replace `@` characters in date string with `T`.
-   * @param {string} dateString
-   * @returns {string}
-   */
-  static fromSearchApiDate(dateString) {
-    return dateString.replaceAll('/', '-').replaceAll('@', 'T');
-  }
-
-  /**
-   * Converts a date object to the Search API format (`yyyy/MM/dd@hh:mm:ss`), using local time.
-   * @param {Date} date The date object to convert.
-   * @returns {string} The formatted date string.
-   */
-  static toLocalSearchApiDate(date) {
-    const year = date.getFullYear().toString().padStart(4, '0');
-    const month = (date.getMonth() + 1).toString().padStart(2, '0');
-    const day = date.getDate().toString().padStart(2, '0');
-    const hours = date.getHours().toString().padStart(2, '0');
-    const minutes = date.getMinutes().toString().padStart(2, '0');
-    const seconds = date.getSeconds().toString().padStart(2, '0');
-
-    return `${year}/${month}/${day}@${hours}:${minutes}:${seconds}`;
-  }
-
-  /**
-   * Converts a date to the ISO formatted local date.
-   * @param {Date} date The date to convert.
-   * @returns {string} The formatted date string.
-   */
-  static toLocalIsoDate(date) {
-    const year = date.getFullYear().toString().padStart(4, '0');
-    const month = (date.getMonth() + 1).toString().padStart(2, '0');
-    const day = date.getDate().toString().padStart(2, '0');
-
-    return `${year}-${month}-${day}T00:00:00`;
-  }
-
-  /**
-   * Parses an ISO-formatted date string to a date object, using the specified local time.
-   * @param {string} dateString The ISO formatted date string.
-   * @param {number} hours The local hours to set on the date.
-   * @param {number} minutes The local minutes to set on the date.
-   * @param {number} seconds The local seconds to set on the date.
-   * @throws {Error} If specified time is invalid.
-   * @returns {Date} The parsed date.
-   */
-  static fromLocalIsoDate(dateString, hours, minutes, seconds) {
-    const isTimeValid =
-      hours >= 0 &&
-      hours <= 23 &&
-      minutes >= 0 &&
-      minutes <= 59 &&
-      seconds >= 0 &&
-      seconds <= 59;
-    if (!isTimeValid) {
-      throw new Error(
-        'The specified time is invalid. It must be between 00:00:00 and 23:59:59.'
-      );
-    }
-
-    const withoutTime = DateUtils.trimIsoTime(dateString);
-    const time =
-      hours.toString().padStart(2, '0') +
-      ':' +
-      minutes.toString().padStart(2, '0') +
-      ':' +
-      seconds.toString().padStart(2, '0');
-
-    return new Date(`${withoutTime}T${time}`);
+export function unwrapLockerProxiedObject(value) {
+  if (value === null || typeof value !== 'object') {
+    return value;
   }
 
-  /**
-   * Trims the time portion from an ISO 8601 date string.
-   * @param {string} dateString
-   * @returns {string}
-   */
-  static trimIsoTime(dateString) {
-    const timeIdx = dateString.indexOf('T');
-    return timeIdx !== -1 ? dateString.substring(0, timeIdx) : dateString;
+  if (Array.isArray(value)) {
+    return value.map((item) => unwrapLockerProxiedObject(item));
   }
 
-  /**
-   * @param {number} timestamp
-   * @returns {boolean}
-   */
-  static isValidTimestamp(timestamp) {
-    let isValid = true;
-    try {
-      // eslint-disable-next-line no-new
-      new Date(timestamp);
-    } catch (error) {
-      isValid = false;
+  const unwrappedValue = {};
+  for (const key in value) {
+    if (Object.prototype.hasOwnProperty.call(value, key)) {
+      unwrappedValue[key] = unwrapLockerProxiedObject(value[key]);
     }
-    return isValid;
-  }
-
-  /**
-   * 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 (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).
-   */
-  static parseTimestampToDateDetails(timestamp) {
-    const daysOfWeek = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
-    const months = [
-      'January',
-      'February',
-      'March',
-      'April',
-      'May',
-      'June',
-      'July',
-      'August',
-      'September',
-      'October',
-      'November',
-      'December',
-    ];
-
-    const date = new Date(timestamp);
-    const dayOfWeek = daysOfWeek[date.getDay()];
-    const month = months[date.getMonth()];
-    const day = date.getDate();
-    const year = date.getFullYear();
-    const hours = date.getHours();
-    const minutes = date.getMinutes();
-
-    return {
-      year,
-      month,
-      dayOfWeek,
-      day,
-      hours,
-      minutes,
-    };
-  }
-}
-
-/**
- * Converts a date string from the Coveo Search API format to the ISO-8601 format.
- * Replace `/` characters in date string with `-`.
- * Replace `@` characters in date string with `T`.
- * @param {string} dateString
- * @returns {string}
- */
-export function fromSearchApiDate(dateString) {
-  return DateUtils.fromSearchApiDate(dateString);
-}
-
-/**
- * Formats relative date ranges into human-readable strings.
- * Supports past and future date ranges with proper pluralization.
- */
-export class RelativeDateFormatter {
-  constructor() {
-    this.singularIndex = 0;
-    this.pluralIndex = 1;
-
-    this.labels = {
-      'past-hour': [pastHour, pastHour_plural],
-      'past-day': [pastDay, pastDay_plural],
-      'past-week': [pastWeek, pastWeek_plural],
-      'past-month': [pastMonth, pastMonth_plural],
-      'past-quarter': [pastQuarter, pastQuarter_plural],
-      'past-year': [pastYear, pastYear_plural],
-      'next-hour': [nextHour, nextHour_plural],
-      'next-day': [nextDay, nextDay_plural],
-      'next-week': [nextWeek, nextWeek_plural],
-      'next-month': [nextMonth, nextMonth_plural],
-      'next-quarter': [nextQuarter, nextQuarter_plural],
-      'next-year': [nextYear, nextYear_plural],
-    };
   }
 
-  /**
-   * Formats a relative date range into a human-readable string.
-   * @param {RelativeDate} begin The beginning of the relative date range.
-   * @param {RelativeDate} end The end of the relative date range.
-   * @returns {string} The formatted human-readable date range.
-   * @throws {Error} If the provided relative date range is invalid.
-   * @example
-   * begin = { period: 'past', unit: 'day', amount: 2 };
-   * end = { period: 'now', unit: 'day', amount: 1 };
-   * Output: "2 days ago - 1 day ago"
-   */
-  formatRange(begin, end) {
-    const isPastRange = begin.period === 'past' && end.period === 'now';
-    const isNextRange = begin.period === 'now' && end.period === 'next';
-
-    if (!isPastRange && !isNextRange) {
-      throw new Error(
-        'The provided relative date range is invalid. Either "begin" or "end" must have the "period" set to "now".'
-      );
-    }
-
-    const relativeDate = isPastRange ? begin : end;
-    const label =
-      this.labels[`${relativeDate.period}-${relativeDate.unit}`][
-        I18nUtils.isSingular(relativeDate.amount)
-          ? this.singularIndex
-          : this.pluralIndex
-      ];
-
-    return I18nUtils.format(label, relativeDate.amount);
-  }
+  return unwrappedValue;
 }
 
 /**