@coveo/quantic 3.14.2 → 3.15.0

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/product.d.ts

@@ -123,6 +123,12 @@ export interface BaseProduct {
     /**
      * The length and offset of each word to highlight in the product excerpt string.
      */
+    excerptHighlights?: HighlightKeyword[];
+    /**
+     * @deprecated Use `excerptHighlights` instead.
+     *
+     * The length and offset of each word to highlight in the product excerpt string.
+     */
     excerptsHighlights?: HighlightKeyword[];
 }
 export interface Product extends BaseProduct {

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts

@@ -1,8 +1,8 @@
-import { EventSourceMessage } from '@microsoft/fetch-event-source';
 import { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
 import { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
 import { SearchAppState } from '../../state/search-app-state.js';
 import { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection } from '../../state/state-sections.js';
+import { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
 import { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
 import { SearchRequest } from '../search/search/search-request.js';
 export type StateNeededByAnswerAPI = {

package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/core-engine.d.ts

@@ -39,6 +39,15 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
      * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.
      */
     setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
+    /**
+     * Returns the access token.
+     */
+    getAccessToken: () => string;
+    /**
+     * Updates the access token.
+     * @param accessToken - The access token to update.
+     */
+    setAccessToken: (accessToken: string) => void;
 }
 export type InferStaticState<T extends {
     fetchStaticState(...args: unknown[]): Promise<unknown>;

package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts

@@ -119,11 +119,16 @@ export type { RedirectionTrigger, RedirectionTriggerState, } from './controllers
 export { buildRedirectionTrigger } from './controllers/commerce/triggers/headless-redirection-trigger.js';
 export type { QueryTrigger, QueryTriggerState, } from './controllers/core/triggers/headless-core-query-trigger.js';
 export { buildQueryTrigger } from './controllers/commerce/triggers/headless-query-trigger.js';
-export type { FieldSuggestions, FieldSuggestionsState, } from './controllers/commerce/field-suggestions/headless-field-suggestions.js';
 export type { CategoryFieldSuggestions, CategoryFieldSuggestionsState, } from './controllers/commerce/field-suggestions/headless-category-field-suggestions.js';
 export type { FieldSuggestionsGenerator, GeneratedFieldSuggestionsControllers, } from './controllers/commerce/field-suggestions/headless-field-suggestions-generator.js';
 export type { FieldSuggestionsFacet } from './features/commerce/facets/field-suggestions-order/field-suggestions-order-state.ts';
 export { buildFieldSuggestionsGenerator } from './controllers/commerce/field-suggestions/headless-field-suggestions-generator.js';
+export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
+export { buildFilterSuggestionsGenerator } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
+export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, } from './controllers/commerce/filter-suggestions/headless-category-filter-suggestions.js';
+export { buildCategoryFilterSuggestions } from './controllers/commerce/filter-suggestions/headless-category-filter-suggestions.js';
+export type { FilterSuggestions, FilterSuggestionsState, } from './controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
+export { buildFilterSuggestions } from './controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
 export type { ParameterManager, ParameterManagerState, ParameterManagerProps, ParameterManagerInitialState, } from './controllers/commerce/core/parameter-manager/headless-core-parameter-manager.js';
 export type { Parameters } from './features/commerce/parameters/parameters-actions.js';
 export type { SearchParameters } from './features/search-parameters/search-parameter-actions.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-category-field-suggestions.d.ts

@@ -1,5 +1,5 @@
-import { FieldSuggestionsFacet } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
 import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
 import { Controller } from '../../controller/headless-controller.js';
 import { CategoryFieldSuggestionsState as CoreCategoryFieldSuggestionsState, CategoryFieldSuggestionsValue } from '../../field-suggestions/category-facet/headless-category-field-suggestions.js';
 import { CategoryFacetOptions } from '../core/facets/category/headless-commerce-category-facet.js';
@@ -10,6 +10,8 @@ export type { CategoryFieldSuggestionsValue };
  *
  * @group Buildable controllers
  * @category CategoryFieldSuggestions
+ * @alpha
+ * @deprecated
  */
 export type CategoryFieldSuggestionsState = CoreCategoryFieldSuggestionsState & Pick<FieldSuggestionsFacet, 'facetId' | 'displayName' | 'field'>;
 /**
@@ -21,6 +23,8 @@ export type CategoryFieldSuggestionsState = CoreCategoryFieldSuggestionsState &
  *
  * @group Buildable controllers
  * @category CategoryFieldSuggestions
+ * @alpha
+ * @deprecated
  */
 export interface CategoryFieldSuggestions extends Controller, FacetControllerType<'hierarchical'> {
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-field-suggestions-generator.d.ts

@@ -2,13 +2,18 @@ import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js'
 import { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
 import { Controller } from '../../controller/headless-controller.js';
 import { CategoryFieldSuggestions } from './headless-category-field-suggestions.js';
-import { FieldSuggestions } from './headless-field-suggestions.js';
-export type GeneratedFieldSuggestionsControllers = Array<FieldSuggestions | CategoryFieldSuggestions>;
+/**
+ * @alpha
+ * @deprecated
+ */
+export type GeneratedFieldSuggestionsControllers = Array<CategoryFieldSuggestions>;
 /**
  * The `FieldSuggestionsGenerator` controller is responsible for generating field suggestions controllers for a given commerce engine.
  *
  * @group Buildable controllers
  * @category FieldSuggestionsGenerator
+ * @alpha
+ * @deprecated
  */
 export interface FieldSuggestionsGenerator extends Controller {
     /**
@@ -27,5 +32,7 @@ export interface FieldSuggestionsGenerator extends Controller {
  *
  * @group Buildable controllers
  * @category FieldSuggestionsGenerator
+ * @alpha
+ * @deprecated
  */
 export declare function buildFieldSuggestionsGenerator(engine: CommerceEngine): FieldSuggestionsGenerator;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-category-filter-suggestions.d.ts

@@ -0,0 +1,87 @@
+import { FieldSuggestionsFacet } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
+import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { Controller } from '../../controller/headless-controller.js';
+import { CategoryFieldSuggestionsState as CoreCategoryFieldSuggestionsState, CategoryFieldSuggestionsValue } from '../../field-suggestions/category-facet/headless-category-field-suggestions.js';
+import { CategoryFacetOptions } from '../core/facets/category/headless-commerce-category-facet.js';
+import { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
+export type { CategoryFieldSuggestionsValue };
+/**
+ * The state of the `CategoryFilterSuggestions` controller.
+ *
+ * @group Buildable controllers
+ * @category CategoryFilterSuggestions
+ */
+export type CategoryFilterSuggestionsState = CoreCategoryFieldSuggestionsState & Pick<FieldSuggestionsFacet, 'facetId' | 'displayName' | 'field'>;
+/**
+ * The `CategoryFilterSuggestions` controller provides methods to request and interact with category facet suggestions
+ * based on a specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category CategoryFilterSuggestions
+ */
+export interface CategoryFilterSuggestions extends Controller, FacetControllerType<'hierarchical'> {
+    /**
+     * Resets the query in the controller state and clears the category filter suggestions.
+     */
+    clear(): void;
+    /**
+     * Returns the serialized search parameters for the current search query and specified category filter suggestion.
+     *
+     * For example, `q=jeans&cf-ec-category=Clothes,Pants`.
+     *
+     * In a typical scenario, this method should called when the user selects a category filter suggestion from a
+     * standalone search box. The returned string is then used to pass the correct URL query parameters or fragment when
+     * redirecting the browser to the search page.
+     *
+     * When the user selects a category filter suggestion from the main search box on the search page, use the `select`
+     * method instead.
+     *
+     * @param value - The category filter suggestion to serialize.
+     * @returns The serialized search parameters for the current search query and specified category filter suggestion.
+     */
+    getSearchParameters(value: CategoryFieldSuggestionsValue): string;
+    /**
+     * Clears all facet values, selects the specified category filter suggestion, updates the query, and executes a new
+     * search request.
+     *
+     * In a typical scenario, this method should be called when the user selects a category filter suggestion from the
+     * main search box on the search page.
+     *
+     * When the user selects a category filter suggestion from a standalone search box, use the `getSearchParameters`
+     * method instead.
+     *
+     * @param value - The category filter suggestion to select.
+     */
+    select(value: CategoryFieldSuggestionsValue): void;
+    /**
+     * Sets the query in the controller state to the specified value and requests category filter suggestions based on the
+     * updated query.
+     *
+     * For example, if this method is called with `jeans` as an argument, it will request values from the controller's
+     * field (e.g., `ec_category`) that would return results if selected when the search query is `jeans` (such as
+     * `Clothing`, `Clothing;Pants`, and `Clothing;Shorts`).
+     *
+     * @param query - The search query to use as context to request the category filter suggestions. In a typical
+     * scenario, this should set to the current value of the search box input.
+     */
+    updateQuery(query: string): void;
+    state: CategoryFilterSuggestionsState;
+}
+/**
+ * The `CategoryFilterSuggestions` controller provides methods to request and interact with category facet suggestions
+ * based on a specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @param engine - The headless commerce engine.
+ * @param options - The options for the `CategoryFilterSuggestions` controller.
+ * @returns A `CategoryFilterSuggestions` controller instance.
+ *
+ * @group Buildable controllers
+ * @category CategoryFilterSuggestions
+ */
+export declare function buildCategoryFilterSuggestions(engine: CommerceEngine, options: CategoryFacetOptions): CategoryFilterSuggestions;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.d.ts

@@ -0,0 +1,38 @@
+import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
+import { Controller } from '../../controller/headless-controller.js';
+import { CategoryFilterSuggestions } from './headless-category-filter-suggestions.js';
+import { FilterSuggestions } from './headless-filter-suggestions.js';
+export type GeneratedFilterSuggestionsControllers = Array<FilterSuggestions | CategoryFilterSuggestions>;
+/**
+ * The `FilterSuggestionsGenerator` controller is responsible for generating filter suggestions controllers for a given
+ * commerce engine.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to use this
+ * feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestionsGenerator
+ */
+export interface FilterSuggestionsGenerator extends Controller {
+    /**
+     * The filter suggestions controllers created by the filter suggestions generator.
+     */
+    filterSuggestions: GeneratedFilterSuggestionsControllers;
+    /**
+     * The state of the filter suggestions generator.
+     */
+    state: FieldSuggestionsFacet[];
+}
+/**
+ * Builds a filter suggestions generator controller for a given commerce engine.
+ * @param engine - The commerce engine.
+ * @returns The filter suggestions generator controller.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestionsGenerator
+ */
+export declare function buildFilterSuggestionsGenerator(engine: CommerceEngine): FilterSuggestionsGenerator;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts

@@ -0,0 +1,16 @@
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { FilterSuggestionsGenerator } from './headless-filter-suggestions-generator.js';
+export type { FilterSuggestions, FilterSuggestionsState, } from './headless-filter-suggestions.js';
+export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, } from './headless-category-filter-suggestions.js';
+export type { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
+export type { GeneratedFilterSuggestionsControllers as GeneratedFilterSuggestionsControllers } from './headless-filter-suggestions-generator.js';
+export type { FilterSuggestionsGenerator as FilterSuggestionsGenerator };
+export interface FilterSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator> {
+}
+/**
+ * Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
+ * @group Definers
+ *
+ * @returns The `FilterSuggestionsGenerator` controller definition.
+ */
+export declare function defineFilterSuggestionsGenerator(): FilterSuggestionsGeneratorDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions.d.ts

@@ -0,0 +1,88 @@
+import { FieldSuggestionsFacet } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
+import { SpecificFacetSearchResult } from '../../../api/search/facet-search/specific-facet-search/specific-facet-search-response.js';
+import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { Controller } from '../../controller/headless-controller.js';
+import { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
+import { RegularFacetSearchState } from '../core/facets/regular/headless-commerce-regular-facet-search.js';
+import { RegularFacetOptions } from '../core/facets/regular/headless-commerce-regular-facet.js';
+export type { SpecificFacetSearchResult };
+/**
+ * The state of the `FilterSuggestions` controller.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestions
+ */
+export type FilterSuggestionsState = RegularFacetSearchState & Pick<FieldSuggestionsFacet, 'facetId' | 'displayName' | 'field'>;
+/**
+ * The `FilterSuggestions` controller provides methods to request and interact with facet suggestions based on a
+ * specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestions
+ */
+export interface FilterSuggestions extends Controller, FacetControllerType<'regular'> {
+    /**
+     * Resets the query in the controller state and clears the filter suggestions.
+     */
+    clear(): void;
+    /**
+     * Returns the serialized search parameters for the current search query and specified filter suggestion.
+     *
+     * For example, `q=jeans&f-cat_color=Blue`.
+     *
+     * In a typical scenario, this method should be called when the user selects a filter suggestion from a standalone
+     * search box. The returned string is then used to pass the correct URL query parametes or fragment when redirecting
+     * the browser to the search page.
+     *
+     * When the user selects a filter suggestion from the main search box on the search page, use the `select` method
+     * instead.
+     *
+     * @param value - The filter suggestion to serialize.
+     * @returns The serialized search parameters for the current search query and specified filter suggestion.
+     */
+    getSearchParameters(value: SpecificFacetSearchResult): string;
+    /**
+     * Clears all facet values, selects the specified filter suggestion, updates the query, and executes a new search
+     * request.
+     *
+     * In a typical scenario, this method should be called when the user selects a filter suggestion from the main search
+     * box on the search page.
+     *
+     * When the user selects a filter suggestion from a standalone search box, use the `getSearchParameters` method
+     * instead.
+     *
+     * @param value - The filter suggestion to select.
+     */
+    select(value: SpecificFacetSearchResult): void;
+    /**
+     * Sets the query in the controller state to the specified value and requests filter suggestions based on the updated
+     * query.
+     *
+     * For example, if this method is called with `jeans` as an argument, it will request values from the controller's
+     * field (e.g., `ec_brand`) that would return results if selected when the search query is `jeans` (such as
+     * `Calvin Klein`, `Columbia`, and `Nautica`).
+     *
+     * @param query - The search query to use as context to request the category filter suggestions. In a typical
+     * scenario, this should set to the current value of the search box input.
+     */
+    updateQuery(query: string): void;
+    state: FilterSuggestionsState;
+}
+/**
+ * The `FilterSuggestions` controller provides methods to request and interact with facet suggestions based on a
+ * specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to use this
+ * feature in an implementation, please contact your Coveo representative.
+ *
+ * @param engine - The headless commerce engine.
+ * @param options - The options for the `FilterSuggestions` controller.
+ * @returns A `FilterSuggestions` controller instance.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestions
+ */
+export declare function buildFilterSuggestions(engine: CommerceEngine, options: RegularFacetOptions): FilterSuggestions;

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

@@ -41,13 +41,15 @@ export interface CategoryFacetOptions {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all of the potential facet values.
      *
-     * **Note:** A high `injectionDepth` may reduce facet request performance.
+     * Note: A high `injectionDepth` may reduce facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -24,13 +24,15 @@ export interface FacetOptions {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -24,13 +24,15 @@ export interface DateFilterOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -38,13 +38,15 @@ export interface DateFacetOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -24,13 +24,15 @@ export interface NumericFilterOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -42,13 +42,15 @@ export interface NumericFacetOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -24,13 +24,15 @@ export interface FacetOptions {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -41,13 +41,15 @@ export interface RegisterCategoryFacetActionCreatorPayload {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -9,12 +9,15 @@ export interface BaseFacetRequest {
     /** The field whose values you want to display in the facet.*/
     field: string;
     /** Whether to exclude folded result parents when estimating the result count for each facet value.
+     *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount: boolean;
     /** The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -24,13 +24,15 @@ export interface RegisterFacetActionCreatorPayload {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -39,13 +39,15 @@ export interface RegisterDateFacetActionCreatorPayload {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -39,13 +39,15 @@ export interface RegisterNumericFacetActionCreatorPayload {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts

@@ -113,8 +113,8 @@ export type { Summary, ProductListingSummaryState, RecommendationsSummaryState,
 export { defineSummary } from './controllers/commerce/core/summary/headless-core-summary.ssr.js';
 export type { RecentQueriesList, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesListInitialState, RecentQueriesState, RecentQueriesListDefinition, } from './controllers/commerce/recent-queries-list/headless-recent-queries-list.ssr.js';
 export { defineRecentQueriesList } from './controllers/commerce/recent-queries-list/headless-recent-queries-list.ssr.js';
-export type { FieldSuggestions, FieldSuggestionsState, CategoryFieldSuggestions, CategoryFieldSuggestionsState, FieldSuggestionsFacet, GeneratedFieldSuggestionsControllers, FieldSuggestionsGenerator, FieldSuggestionsGeneratorDefinition, } from './controllers/commerce/field-suggestions/headless-field-suggestions-generator.ssr.js';
-export { defineFieldSuggestionsGenerator } from './controllers/commerce/field-suggestions/headless-field-suggestions-generator.ssr.js';
+export type { FilterSuggestions, FilterSuggestionsState, CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, GeneratedFilterSuggestionsControllers, FilterSuggestionsGenerator, FilterSuggestionsGeneratorDefinition, } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
+export { defineFilterSuggestionsGenerator } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
 export type { NotifyTrigger, NotifyTriggerState, NotifyTriggerDefinition, } from './controllers/commerce/triggers/headless-notify-trigger.ssr.js';
 export { defineNotifyTrigger } from './controllers/commerce/triggers/headless-notify-trigger.ssr.js';
 export type { QueryTrigger, QueryTriggerState, QueryTriggerDefinition, } from './controllers/commerce/triggers/headless-query-trigger.ssr.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/fetch.d.ts

@@ -0,0 +1,44 @@
+import { EventSourceMessage } from './parse.js';
+export declare const EventStreamContentType = "text/event-stream";
+export interface FetchEventSourceInit extends RequestInit {
+    /**
+     * The request headers. FetchEventSource only supports the Record<string,string> format.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Called when a response is received. Use this to validate that the response
+     * actually matches what you expect (and throw if it doesn't.) If not provided,
+     * will default to a basic validation to ensure the content-type is text/event-stream.
+     */
+    onopen?: (response: Response) => Promise<void>;
+    /**
+     * Called when a message is received. NOTE: Unlike the default browser
+     * EventSource.onmessage, this callback is called for _all_ events,
+     * even ones with a custom `event` field.
+     */
+    onmessage?: (ev: EventSourceMessage) => void;
+    /**
+     * Called when a response finishes. If you don't expect the server to kill
+     * the connection, you can throw an exception here and retry using onerror.
+     */
+    onclose?: () => void;
+    /**
+     * Called when there is any error making the request / processing messages /
+     * handling callbacks etc. Use this to control the retry strategy: if the
+     * error is fatal, rethrow the error inside the callback to stop the entire
+     * operation. Otherwise, you can return an interval (in milliseconds) after
+     * which the request will automatically retry (with the last-event-id).
+     * If this callback is not specified, or it returns undefined, fetchEventSource
+     * will treat every error as retryable and will try again after 1 second.
+     */
+    onerror?: (err: unknown) => number | null | undefined | void;
+    /**
+     * If true, will keep the request open even if the document is hidden.
+     * By default, fetchEventSource will close the request and reopen it
+     * automatically when the document becomes visible again.
+     */
+    openWhenHidden?: boolean;
+    /** The Fetch function to use. Defaults to window.fetch */
+    fetch?: typeof fetch;
+}
+export declare function fetchEventSource(input: RequestInfo, { signal: inputSignal, headers: inputHeaders, onopen: inputOnOpen, onmessage, onclose, onerror, openWhenHidden, fetch: inputFetch, ...rest }: FetchEventSourceInit): Promise<void>;

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/index.d.ts

@@ -0,0 +1,2 @@
+export { fetchEventSource, type FetchEventSourceInit, EventStreamContentType, } from './fetch.js';
+export { type EventSourceMessage } from './parse.js';