@coveo/quantic 3.26.1-pre.f7120f5ae4 → 3.26.1

package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/search-engine-configuration.d.ts

@@ -60,7 +60,7 @@ export interface SearchConfigurationOptions {
     /**
      * The base URL to use to proxy Coveo search requests (e.g., `https://example.com/search`).
      *
-     * This is an advanced option that you should only set if you need to proxy Coveo searchrequests through your own
+     * This is an advanced option that you only set if you proxy Coveo searchrequests through your own
      * server. In most cases, you should not set this option.
      *
      *  See [Headless proxy: Search](https://docs.coveo.com/en/headless/latest/usage/proxy#search).

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.d.ts

@@ -33,10 +33,10 @@ export interface FacetGenerator extends Omit<CSRFacetGenerator, 'state' | 'facet
     /**
      * The state of each every facet returned by the Commerce API.
      *
-     * In a server-side rendering (SSR) scenario, you must use this state to render the facet UI components before the
+     * In a server-side rendering (SSR) scenario, use this state to render the facet UI components before the
      * facet controller is hydrated on the client side.
      *
-     * Once the facet generator controller has been hydrated, you must use the `getFacetController` method to retrieve
+     * Once the facet generator controller has been hydrated, use the `getFacetController` method to retrieve
      * the individual facet controllers and subscribe to their respective states.
      */
     state: FacetGeneratorState;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/did-you-mean/headless-did-you-mean.d.ts

@@ -13,7 +13,7 @@ export interface DidYouMean extends Controller {
     /**
      * Executes a search using the suggested query correction.
      *
-     * Typically, you should only call this method when `state.hasQueryCorrection` is `true` and `state.wasAutomaticallyCorrected` is `false`.
+     * Typically, you only call this method when `state.hasQueryCorrection` is `true` and `state.wasAutomaticallyCorrected` is `false`.
      * When this is the case, you could call this method when the user clicks a link to search with the suggested query correction rather than
      * with the query they originally submitted.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/category-facet/headless-core-category-facet-options.d.ts

@@ -2,7 +2,7 @@ import { Schema } from '@coveo/bueno';
 import { type CategoryFacetSortCriterion } from '../../../../features/facets/category-facet-set/interfaces/request.js';
 export interface CategoryFacetOptions {
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      * */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet-options.d.ts

@@ -3,7 +3,7 @@ import { type FacetResultsMustMatch } from '../../../../features/facets/facet-ap
 import { type FacetSortCriterion } from '../../../../features/facets/facet-set/interfaces/request.js';
 export interface FacetOptions {
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      * */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.d.ts

@@ -6,7 +6,7 @@ import { type Controller } from '../../../../controller/headless-controller.js';
  */
 export interface DateFilterOptions {
     /**
-     * The field whose values you want to display in the filter.
+     * The values of which field to display in the filter.
      */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-date-facet-options.d.ts

@@ -5,7 +5,7 @@ import { type RangeFacetRangeAlgorithm, type RangeFacetSortCriterion } from '../
 import type { ConfigurationSection, DateFacetSection, SearchSection } from '../../../../../state/state-sections.js';
 export interface DateFacetOptions {
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      */
     field: string;
     /**
@@ -18,7 +18,7 @@ export interface DateFacetOptions {
     /**
      * Whether the index should automatically create range values.
      *
-     * Tip: If you set this parameter to true, you should ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
+     * Tip: If you set this parameter to true, ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
      */
     generateAutomaticRanges: boolean;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.d.ts

@@ -6,7 +6,7 @@ import { type Controller } from '../../../../controller/headless-controller.js';
  */
 export interface NumericFilterOptions {
     /**
-     * The field whose values you want to display in the filter.
+     * The values of which field to display in the filter.
      */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-numeric-facet-options.d.ts

@@ -9,7 +9,7 @@ import type { ConfigurationSection, NumericFacetSection, SearchSection } from '.
  */
 export interface NumericFacetOptions {
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      */
     field: string;
     /**
@@ -22,7 +22,7 @@ export interface NumericFacetOptions {
     /**
      * Whether the index should automatically create range values.
      *
-     * Tip: If you set this parameter to true, you should ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
+     * Tip: If you set this parameter to true, ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
      */
     generateAutomaticRanges: boolean;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet/headless-core-smart-snippet.d.ts

@@ -63,7 +63,7 @@ export interface SmartSnippetCore extends Controller {
     /**
      * Selects the source, logging a UA event to the Coveo Platform if the source wasn't already selected before.
      *
-     * In a DOM context, we recommend calling this method on all of the following events:
+     * In a DOM context, call this method on all of the following events:
      * * `contextmenu`
      * * `click`
      * * `mouseup`
@@ -73,13 +73,13 @@ export interface SmartSnippetCore extends Controller {
     /**
      * Prepares to select the source after a certain delay, sending analytics if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on the `touchstart` event.
+     * In a DOM context, call this method on the `touchstart` event.
      */
     beginDelayedSelectSource(): void;
     /**
      * Cancels the pending selection caused by `beginDelayedSelectSource`.
      *
-     * In a DOM context, we recommend calling this method on the `touchend` event.
+     * In a DOM context, call this method on the `touchend` event.
      */
     cancelPendingSelectSource(): void;
 }
@@ -95,7 +95,7 @@ export interface SmartSnippet extends SmartSnippetCore {
     /**
      * Selects a link inside the answer, logging a UA event to the Coveo Platform if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on all of the following events:
+     * In a DOM context, call this method on all of the following events:
      * * `contextmenu`
      * * `click`
      * * `mouseup`
@@ -107,7 +107,7 @@ export interface SmartSnippet extends SmartSnippetCore {
     /**
      * Prepares to select a link inside the answer after a certain delay, sending analytics if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on the `touchstart` event.
+     * In a DOM context, call this method on the `touchstart` event.
      *
      * @param link - The link to select.
      */
@@ -115,7 +115,7 @@ export interface SmartSnippet extends SmartSnippetCore {
     /**
      * Cancels the pending selection caused by `beginDelayedSelectInlineLink`.
      *
-     * In a DOM context, we recommend calling this method on the `touchend` event.
+     * In a DOM context, call this method on the `touchend` event.
      *
      * @param link - The link to select.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet/headless-automatic-facet.d.ts

@@ -6,7 +6,7 @@ import type { AutomaticFacet } from '../automatic-facet-generator/headless-autom
  */
 export interface AutomaticFacetProps {
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      */
     field: string;
 }

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/facet/headless-facet-options.d.ts

@@ -3,7 +3,7 @@ import { type FacetResultsMustMatch } from '../../../features/facets/facet-api/r
 import { type FacetSortCriterion } from '../../../features/facets/facet-set/interfaces/request.js';
 export interface FacetOptions {
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      * */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.d.ts

@@ -25,7 +25,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Selects the source, logging a UA event to the Coveo Platform if the source hadn't been selected before.
      *
-     * In a DOM context, we recommend calling this method on all of the following events:
+     * In a DOM context, call this method on all of the following events:
      * * `contextmenu`
      * * `click`
      * * `mouseup`
@@ -37,7 +37,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Prepares to select the source after a certain delay, sending analytics if it hadn't been selected before.
      *
-     * In a DOM context, we recommend calling this method on the `touchstart` event.
+     * In a DOM context, call this method on the `touchstart` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet to collapse.
      */
@@ -45,7 +45,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Cancels the pending selection caused by `beginDelayedSelect`.
      *
-     * In a DOM context, we recommend calling this method on the `touchend` event.
+     * In a DOM context, call this method on the `touchend` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet to collapse.
      */
@@ -53,7 +53,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Selects a link inside an answer, logging a UA event to the Coveo Platform if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on all of the following events:
+     * In a DOM context, call this method on all of the following events:
      * * `contextmenu`
      * * `click`
      * * `mouseup`
@@ -66,7 +66,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Prepares to select a link inside an answer after a certain delay, sending analytics if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on the `touchstart` event.
+     * In a DOM context, call this method on the `touchstart` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet containing the link.
      * @param link - The link to select.
@@ -75,7 +75,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Cancels the pending selection caused by `beginDelayedSelectInlineLink`.
      *
-     * In a DOM context, we recommend calling this method on the `touchend` event.
+     * In a DOM context, call this method on the `touchend` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet containing the link.
      * @param link - The link to select.

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts

@@ -27,7 +27,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Selects the source, logging a UA event to the Coveo Platform if the source hadn't been selected before.
      *
-     * In a DOM context, we recommend calling this method on all of the following events:
+     * In a DOM context, call this method on all of the following events:
      * * `contextmenu`
      * * `click`
      * * `mouseup`
@@ -39,7 +39,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Prepares to select the source after a certain delay, sending analytics if it hadn't been selected before.
      *
-     * In a DOM context, we recommend calling this method on the `touchstart` event.
+     * In a DOM context, call this method on the `touchstart` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet to collapse.
      */
@@ -47,7 +47,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Cancels the pending selection caused by `beginDelayedSelect`.
      *
-     * In a DOM context, we recommend calling this method on the `touchend` event.
+     * In a DOM context, call this method on the `touchend` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet to collapse.
      */
@@ -55,7 +55,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Selects a link inside an answer, logging a UA event to the Coveo Platform if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on all of the following events:
+     * In a DOM context, call this method on all of the following events:
      * * `contextmenu`
      * * `click`
      * * `mouseup`
@@ -68,7 +68,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Prepares to select a link inside an answer after a certain delay, sending analytics if it was never selected before.
      *
-     * In a DOM context, we recommend calling this method on the `touchstart` event.
+     * In a DOM context, call this method on the `touchstart` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet containing the link.
      * @param link - The link to select.
@@ -77,7 +77,7 @@ export interface SmartSnippetQuestionsList extends CoreSmartSnippetQuestionsList
     /**
      * Cancels the pending selection caused by `beginDelayedSelectInlineLink`.
      *
-     * In a DOM context, we recommend calling this method on the `touchend` event.
+     * In a DOM context, call this method on the `touchend` event.
      *
      * @param identifier - The `questionAnswerId` of the smart snippet containing the link.
      * @param link - The link to select.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-actions.d.ts

@@ -10,7 +10,7 @@ export interface SetCaseAssistConfigurationActionCreatorPayload {
     /**
      * The base URL to use to proxy Coveo case assist requests (e.g., `https://example.com/search`).
      *
-     * This is an advanced option that you should only set if you need to proxy Coveo case assist through your own
+     * This is an advanced option that you only set if you proxy Coveo case assist through your own
      * server. In most cases, you should not set this option.
      *
      *  See [Headless proxy: Case Assist](https://docs.coveo.com/en/headless/latest/usage/proxy#case-assist).

package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-state.d.ts

@@ -11,7 +11,7 @@ export interface CaseAssistConfigurationState {
     /**
      * The base URL to use to proxy Coveo case assist requests (e.g., `https://example.com/search`).
      *
-     * This is an advanced option that you should only set if you need to proxy Coveo case assist through your own
+     * This is an advanced option that you only set if you proxy Coveo case assist through your own
      * server. In most cases, you should not set this option.
      *
      *  See [Headless proxy: Case Assist](https://docs.coveo.com/en/headless/latest/usage/proxy#case-assist).

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-actions.d.ts

@@ -5,7 +5,7 @@ export type UpdateProxyBaseUrlPayload = {
     /**
      * The base URL to use to proxy Coveo commerce requests (e.g., `https://example.com/commerce`).
      *
-     * This is an advanced option that you should only set if you need to proxy Coveo commerce requests through your own
+     * This is an advanced option that you only set if you proxy Coveo commerce requests through your own
      * server. In most cases, you should not set this option.
      *
      *  See [Headless proxy: Commerce](https://docs.coveo.com/en/headless/latest/usage/proxy#commerce).

package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-actions.d.ts

@@ -23,7 +23,7 @@ export interface UpdateSearchConfigurationActionCreatorPayload {
     /**
      * The base URL to use to proxy Coveo search requests (e.g., `https://example.com/search`).
      *
-     * This is an advanced option that you should only set if you need to proxy Coveo searchrequests through your own
+     * This is an advanced option that you only set if you proxy Coveo searchrequests through your own
      * server. In most cases, you should not set this option.
      *
      *  See [Headless proxy: Search](https://docs.coveo.com/en/headless/latest/usage/proxy#search).
@@ -76,7 +76,7 @@ export interface UpdateAnalyticsConfigurationActionCreatorPayload {
     /**
      * The base URL to use to proxy Coveo analytics requests (e.g., `https://example.com/analytics`).
      *
-     * This is an advanced option that you should only set if you need to proxy Coveo analytics requests through your own
+     * This is an advanced option that you only set if you proxy Coveo analytics requests through your own
      * server. In most cases, you should not set this option.
      *
      * See [Headless proxy: Analytics](https://docs.coveo.com/en/headless/latest/usage/proxy#analytics).

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions.d.ts

@@ -6,7 +6,7 @@ export interface RegisterCategoryFacetActionCreatorPayload {
      * */
     facetId: string;
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      * */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-api/request.d.ts

@@ -6,7 +6,7 @@ export interface BaseFacetRequest {
      * By default, a unique random identifier is generated.
      */
     facetId: string;
-    /** The field whose values you want to display in the facet.*/
+    /** The field from which to display values in the facet.*/
     field: string;
     /** Whether to exclude folded result parents when estimating the result count for each facet value.
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions.d.ts

@@ -7,7 +7,7 @@ export interface RegisterFacetActionCreatorPayload {
      * */
     facetId: string;
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      * */
     field: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/date-facet-actions.d.ts

@@ -7,7 +7,7 @@ export interface RegisterDateFacetActionCreatorPayload {
      */
     facetId: string;
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      */
     field: string;
     /**
@@ -27,7 +27,7 @@ export interface RegisterDateFacetActionCreatorPayload {
     /**
      * Whether the index should automatically create range values.
      *
-     * Tip: If you set this parameter to true, you should ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
+     * Tip: If you set this parameter to true, ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
      */
     generateAutomaticRanges: boolean;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/request.d.ts

@@ -9,7 +9,7 @@ export type RangeFacetRangeAlgorithm = 'even' | 'equiprobable';
 export interface AutomaticRanges<T extends boolean> {
     /** Whether the index should automatically create range values.
      *
-     * Tip: If you set this parameter to true, you should ensure that the Use cache for numeric queries option is enabled for the Facet field in your index in order to speed up automatic range evaluation (see [Add or Edit Fields](https://docs.coveo.com/en/1982/index-content/add-or-edit-a-field)).
+     * Tip: If you set this parameter to true, ensure that the Use cache for numeric queries option is enabled for the Facet field in your index in order to speed up automatic range evaluation (see [Add or Edit Fields](https://docs.coveo.com/en/1982/index-content/add-or-edit-a-field)).
      */
     generateAutomaticRanges: T;
 }

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-actions.d.ts

@@ -7,7 +7,7 @@ export interface RegisterNumericFacetActionCreatorPayload {
      */
     facetId: string;
     /**
-     * The field whose values you want to display in the facet.
+     * The field from which to display values in the facet.
      */
     field: string;
     /**
@@ -27,7 +27,7 @@ export interface RegisterNumericFacetActionCreatorPayload {
     /**
      * Whether the index should automatically create range values.
      *
-     * Tip: If you set this parameter to true, you should ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
+     * Tip: If you set this parameter to true, ensure that the ['Use cache for numeric queries' option](https://docs.coveo.com/en/1833#use-cache-for-numeric-queries) is enabled for this facet's field in your index in order to speed up automatic range evaluation.
      */
     generateAutomaticRanges: boolean;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort-criteria/criteria-parser.d.ts

@@ -7,7 +7,7 @@ import { type SortCriterion } from './criteria.js';
  * - `relevancy`
  * - `date ascending`/`date descending`
  * - `qre`
- * - `field ascending`/`field descending`, where you must replace `field` with the name of a sortable field in your index (e.g., `criteria="size ascending"`).
+ * - `field ascending`/`field descending`, where you replace `field` with the name of a sortable field in your index (e.g., `criteria="size ascending"`).
  *
  * You can specify multiple sort criteria to be used in the same request by separating them with a comma (e.g., `criteria="size ascending, date ascending"` ).
  */